specter-desktop/mkdocs.yml

71 lines
1.9 KiB
YAML
Raw Permalink Normal View History

site_name: Specter Desktop Documentation
site_url: https://docs.specter.solutions/desktop
repo_url: https://github.com/cryptoadvance/specter-desktop/
nav:
- Home:
- 'Introduction': README.md
- release-notes.md
Feature: Multisig beginner guide (#1731) * Added pictures * Added text * wrote more in the guide * Added links to vendors websites * Added more links * Added fingerprints in fig * added links ot other guides * Improved arrows * Added links * Better sub-bullets * Changed the Testing part * typos * Chore: Adjusted releasing process and adding liquidissuer (#1716) * refactor build-linux to avoid build-ci.sh * adding set_setup_py_version to release_helper * yet another tiny release-helper * adjusted for win-compatibility * fix windows build again * fix directory-change * part2 * kick * kick * kick * kick * dependencie for ./utils * revert before_script * unix, not linux * fix buildscript * restore version.txt * fix * fex exe * bugfix: not exiting directory * kick * kick * kick * adding liquidissuer * docstrings * fix upload locations * some docs * ommit external exts in DevelopmentConfig * simplifying startup for external exts * macos improvements * Merge branch 'master' of github.com:cryptoadvance/specter-desktop into liquidissuer * last build-script adjustements * fixed params gain * reapply lost sys changes * upgrade liquidissuer * remove unnecessary print statement. * remove unnecessary EXTENSION_LIST reduction in Development * Bugfix: disable gunicorn for windows * fix version.py * black * fix build * last fixes for the macos-script * Update src/cryptoadvance/specter/util/reflection.py * Better formatting for cli * a bit of reformating for cli_ext * ignoring elements test * skip test * fix link to specterext-dice * Removed link * Added point about fewer devices added more details * Improved link * Added seed plate comparision link * Changed list character * Added link in frint-end * - changed text to multisig guide - Replaced FAQ link by a link to the docs * Added second link to multisig guide. * Added video plugin to mkdocs * Added requirement mkdocs-video * Added mkdocs-video in the script * reset requirements * solved https://github.com/cryptoadvance/specter-desktop/issues/1736 * Added link in Readme * changed video link * Fixed sublist identation * Changed video guide text * Explained fingerprint * Improved registering multisig setup * Add picture about registering * updated pic * Merged the table from the tradeoff.md into the guide * typo fix * Fixed link * Replaced https://deploy-preview-1731--specter-desktop-docs.netlify.app by https://specter-desktop-docs.netlify.app Co-authored-by: Kim Neunert <k9ert@gmx.de>
2022-06-02 17:29:26 +02:00
- multisig-guide.md
- User Guide:
- faq.md
New documentations #1885 (#2409) * Added install guide 1884 https://github.com/cryptoadvance/specter-desktop/issues/1884 * chore: remove empty file * adding to the menu anr referencing in readme * changing heading levels to enable submenu * adding symlink * Reposition 'OS-Specific Apps' section and update Electrum integration info - Moved 'OS-Specific Apps for Specter Desktop' section to immediately follow 'Installation Methods' for better logical flow and prominence. - Added information about Electrum connection availability since version 2.0.0 in the 'Future Developments of Specter Desktop' section for up-to-date and accurate documentation. -Changed Title to "Installation Method Decision Guide" instead of "Installation Guide" * Create WalletCreationGuide.md * Create DeviceCreationGuide.md * Update docs/DeviceCreationGuide.md commit suggestion from k9ert Co-authored-by: k9ert <k9ert@gmx.de> * Update mkdocs.yml Linked new WalletCreationGuide and DeviceCreationGuide in the Menue * Update WalletCreationGuide.md Added Link to install guide * Update WalletCreationGuide.md Added Link to Node connection guide * Update WalletCreationGuide.md Creating wallet: Reference to import device first Backup wallet: Improved explenation about steel backup * Update DeviceCreationGuide.md Added real world examples for wallets and derivation paths. Linked readme with pictured Step by Step guide. Added Some basic Common Issues, maybe link faq? * Update WalletCreationGuide.md Added examples for Single/Multisig wallets * Update DeviceCreationGuide.md small fix in hierarchy * Update mkdocs.yml swapped device and wallet creation guide. * Update DeviceCreationGuide.md Fixed various comments * Update WalletCreationGuide.md var. fixes * Added feedback from 02/15 * Added feedback from 02/15 fix double space and no new line. * - removed the word cryptocurrency and placed Bitcoin instead. - Pointed out that hardware wallets with shitcoin support are less secure. * - fixed links to other docs - adjusted link integration - removed picture reference in the wallets overview --------- Co-authored-by: Kim Neunert <kim@swanbitcoin.com> Co-authored-by: k9ert <k9ert@gmx.de>
2024-02-27 13:51:23 +01:00
- install_guide.md
- DeviceCreationGuide.md
- WalletCreationGuide.md
- 'Using Tor': tor.md
- 'Signing messages': sign-message.md
- Operating Guide:
- connect-your-node.md
- daemon.md
- performance.md
- reverse-proxy.md
- self-signed-certificates.md
- hwibridge.md
- elements.md
- windows.md
- 'Endless Pacman Troubleshooting': endless-pacman.md
- Development:
- 'Contributing': contributing.md
- 'Developing': development.md
- 'Testing': test-new-releases.md
- build-instructions.md
- 'Continuous Integration': continuous-integration.md
- cypress-testing.md
- 'Architectural Notes': architecture.md
- 'Some Random Dev Thoughts': archblog.md
- API:
- api/README.md
- api/ep_liveness.md
- api/ep_readyness.md
- api/ep_specter.md
- api/ep_specter_fulltxlist.md
- api/ep_wallets_psbt.md
- api/ep_wallets_wallet.md
- Extension Development:
- extensions/intro.md
- extensions/frontend-aspects.md
- extensions/service-configuration.md
- extensions/data-storage.md
- extensions/callbacks.md
- extensions/devices.md
Feature: several things for Spectrum preparation (#1913) * change Node persistence format * Removing the Singleton * mainly refactoring * intermediate commit * fix test * Updated diagram * fix tests * removing simplejsons references * fix tests * remove update, tests working * abstract Node * refining Migration framework: run migrations until they suceed * BrokenCoreConnectionException added to handle lost RPC + some minor error handling fixes * clicking redirects to node config if there is no node connection * AbstractNode * BrokenCoreConnectionException added to handle lost RPC + some minor error handling fixes * clicking redirects to node config if there is no node connection * handling broken connection when there is no other error superseding (i.e. no wallets) * Abstract Node improvements and issue fixing * improving node_info handling * fix test results, property device_manager in user, bcce in get_rpc in node, improved rpc property in node * typos * provide data_folders for extensions * parametrizing include for node_info * Remove initial_node_contribution refactoring welcome * adding convenience methods * extension data-storage * Tests green * Better failure resistence * Enabling Node settings * error handling * adjust_view_model callback * exception Handling * Shielding core from extension flaws * More consistent logging * Refactoring wallets endpoints * Make wallet_overview extendable * butgifex and cleanup * feedback by Manolis * rename BusinessObject to PersistentObject * fix Error-management and rollback information * Nodes.md corrections * frontend-aspects.md (small) corrections * fix tests and address feedback and errormanagement * fix tests, proper error-handling * Fix test_util_reflection * just some little addons to test_util_reflection * fix cleanup_on_exit * migration fix * remove check, add redirect after saving node * fix test (not that cool but what to do?) * upgrade Flask as Flask-SQLAlchemy needs higher Flask version * Revert "upgrade Flask as Flask-SQLAlchemy needs higher Flask version" This reverts commit bf24120f891f2589bd0fd3ddb3df002323181553. * update bug fixed + node manager added to node test * cleanup external_node Co-authored-by: moneymanolis <moneymanolis@protonmail.com>
2022-10-29 15:54:34 +02:00
- extensions/nodes.md
theme:
Feature: Multisig beginner guide (#1731) * Added pictures * Added text * wrote more in the guide * Added links to vendors websites * Added more links * Added fingerprints in fig * added links ot other guides * Improved arrows * Added links * Better sub-bullets * Changed the Testing part * typos * Chore: Adjusted releasing process and adding liquidissuer (#1716) * refactor build-linux to avoid build-ci.sh * adding set_setup_py_version to release_helper * yet another tiny release-helper * adjusted for win-compatibility * fix windows build again * fix directory-change * part2 * kick * kick * kick * kick * dependencie for ./utils * revert before_script * unix, not linux * fix buildscript * restore version.txt * fix * fex exe * bugfix: not exiting directory * kick * kick * kick * adding liquidissuer * docstrings * fix upload locations * some docs * ommit external exts in DevelopmentConfig * simplifying startup for external exts * macos improvements * Merge branch 'master' of github.com:cryptoadvance/specter-desktop into liquidissuer * last build-script adjustements * fixed params gain * reapply lost sys changes * upgrade liquidissuer * remove unnecessary print statement. * remove unnecessary EXTENSION_LIST reduction in Development * Bugfix: disable gunicorn for windows * fix version.py * black * fix build * last fixes for the macos-script * Update src/cryptoadvance/specter/util/reflection.py * Better formatting for cli * a bit of reformating for cli_ext * ignoring elements test * skip test * fix link to specterext-dice * Removed link * Added point about fewer devices added more details * Improved link * Added seed plate comparision link * Changed list character * Added link in frint-end * - changed text to multisig guide - Replaced FAQ link by a link to the docs * Added second link to multisig guide. * Added video plugin to mkdocs * Added requirement mkdocs-video * Added mkdocs-video in the script * reset requirements * solved https://github.com/cryptoadvance/specter-desktop/issues/1736 * Added link in Readme * changed video link * Fixed sublist identation * Changed video guide text * Explained fingerprint * Improved registering multisig setup * Add picture about registering * updated pic * Merged the table from the tradeoff.md into the guide * typo fix * Fixed link * Replaced https://deploy-preview-1731--specter-desktop-docs.netlify.app by https://specter-desktop-docs.netlify.app Co-authored-by: Kim Neunert <k9ert@gmx.de>
2022-06-02 17:29:26 +02:00
name: readthedocs
markdown_extensions:
- mdx_truly_sane_lists # pip3 install mdx_truly_sane_lists mkdocs-video
Feature: Multisig beginner guide (#1731) * Added pictures * Added text * wrote more in the guide * Added links to vendors websites * Added more links * Added fingerprints in fig * added links ot other guides * Improved arrows * Added links * Better sub-bullets * Changed the Testing part * typos * Chore: Adjusted releasing process and adding liquidissuer (#1716) * refactor build-linux to avoid build-ci.sh * adding set_setup_py_version to release_helper * yet another tiny release-helper * adjusted for win-compatibility * fix windows build again * fix directory-change * part2 * kick * kick * kick * kick * dependencie for ./utils * revert before_script * unix, not linux * fix buildscript * restore version.txt * fix * fex exe * bugfix: not exiting directory * kick * kick * kick * adding liquidissuer * docstrings * fix upload locations * some docs * ommit external exts in DevelopmentConfig * simplifying startup for external exts * macos improvements * Merge branch 'master' of github.com:cryptoadvance/specter-desktop into liquidissuer * last build-script adjustements * fixed params gain * reapply lost sys changes * upgrade liquidissuer * remove unnecessary print statement. * remove unnecessary EXTENSION_LIST reduction in Development * Bugfix: disable gunicorn for windows * fix version.py * black * fix build * last fixes for the macos-script * Update src/cryptoadvance/specter/util/reflection.py * Better formatting for cli * a bit of reformating for cli_ext * ignoring elements test * skip test * fix link to specterext-dice * Removed link * Added point about fewer devices added more details * Improved link * Added seed plate comparision link * Changed list character * Added link in frint-end * - changed text to multisig guide - Replaced FAQ link by a link to the docs * Added second link to multisig guide. * Added video plugin to mkdocs * Added requirement mkdocs-video * Added mkdocs-video in the script * reset requirements * solved https://github.com/cryptoadvance/specter-desktop/issues/1736 * Added link in Readme * changed video link * Fixed sublist identation * Changed video guide text * Explained fingerprint * Improved registering multisig setup * Add picture about registering * updated pic * Merged the table from the tradeoff.md into the guide * typo fix * Fixed link * Replaced https://deploy-preview-1731--specter-desktop-docs.netlify.app by https://specter-desktop-docs.netlify.app Co-authored-by: Kim Neunert <k9ert@gmx.de>
2022-06-02 17:29:26 +02:00
plugins:
- search
Feature: Multisig beginner guide (#1731) * Added pictures * Added text * wrote more in the guide * Added links to vendors websites * Added more links * Added fingerprints in fig * added links ot other guides * Improved arrows * Added links * Better sub-bullets * Changed the Testing part * typos * Chore: Adjusted releasing process and adding liquidissuer (#1716) * refactor build-linux to avoid build-ci.sh * adding set_setup_py_version to release_helper * yet another tiny release-helper * adjusted for win-compatibility * fix windows build again * fix directory-change * part2 * kick * kick * kick * kick * dependencie for ./utils * revert before_script * unix, not linux * fix buildscript * restore version.txt * fix * fex exe * bugfix: not exiting directory * kick * kick * kick * adding liquidissuer * docstrings * fix upload locations * some docs * ommit external exts in DevelopmentConfig * simplifying startup for external exts * macos improvements * Merge branch 'master' of github.com:cryptoadvance/specter-desktop into liquidissuer * last build-script adjustements * fixed params gain * reapply lost sys changes * upgrade liquidissuer * remove unnecessary print statement. * remove unnecessary EXTENSION_LIST reduction in Development * Bugfix: disable gunicorn for windows * fix version.py * black * fix build * last fixes for the macos-script * Update src/cryptoadvance/specter/util/reflection.py * Better formatting for cli * a bit of reformating for cli_ext * ignoring elements test * skip test * fix link to specterext-dice * Removed link * Added point about fewer devices added more details * Improved link * Added seed plate comparision link * Changed list character * Added link in frint-end * - changed text to multisig guide - Replaced FAQ link by a link to the docs * Added second link to multisig guide. * Added video plugin to mkdocs * Added requirement mkdocs-video * Added mkdocs-video in the script * reset requirements * solved https://github.com/cryptoadvance/specter-desktop/issues/1736 * Added link in Readme * changed video link * Fixed sublist identation * Changed video guide text * Explained fingerprint * Improved registering multisig setup * Add picture about registering * updated pic * Merged the table from the tradeoff.md into the guide * typo fix * Fixed link * Replaced https://deploy-preview-1731--specter-desktop-docs.netlify.app by https://specter-desktop-docs.netlify.app Co-authored-by: Kim Neunert <k9ert@gmx.de>
2022-06-02 17:29:26 +02:00
- mkdocs-video:
mark: "small_video"
css_style:
width: "70%"
height: "15lw"
min-width: "300px"
min-height: "180px"
- mkdocs-video:
mark: "video"
css_style:
width: "100%"
height: "22.172vw"