GlcoinCore/specter-desktop
1
0
Fork 0
mirror of https://github.com/cryptoadvance/specter-desktop.git synced 2026-08-13 12:33:29 +02:00
Code Issues Projects Releases Packages Wiki Activity Actions 8
specter-desktop/mkdocs.yml

58 lines
1.5 KiB
YAML
Raw Normal View History

Documentation: hosted at docs.specter.solutions (#1463) * mkdocs * adding mkdocs for netlify * fix theme * link to Readme * deleting symlink again * deleting index.md * fix release-notes * several doc improvements and elements installation * move DEVELOPMENT.md and CONTRIBUTING.md in subfolder * multi-site setup * changes site_dir * revert * adding mkdoc-wrapper.sh * removing mkdocs from prod-requirements * more docs * fix test ... no more warning
2021-11-24 18:37:46 +01:00
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
Documentation: hosted at docs.specter.solutions (#1463) * mkdocs * adding mkdocs for netlify * fix theme * link to Readme * deleting symlink again * deleting index.md * fix release-notes * several doc improvements and elements installation * move DEVELOPMENT.md and CONTRIBUTING.md in subfolder * multi-site setup * changes site_dir * revert * adding mkdoc-wrapper.sh * removing mkdocs from prod-requirements * more docs * fix test ... no more warning
2021-11-24 18:37:46 +01:00
- User Guide:
- faq.md
- 'Using Tor': tor.md
Docs: message signature (#1310) * message signature * move images and usb/hwi remark * add to docs Co-authored-by: benk10 <ben.kaufman10@gmail.com>
2021-11-30 14:22:54 +01:00
- 'Signing messages': sign-message.md
Documentation: hosted at docs.specter.solutions (#1463) * mkdocs * adding mkdocs for netlify * fix theme * link to Readme * deleting symlink again * deleting index.md * fix release-notes * several doc improvements and elements installation * move DEVELOPMENT.md and CONTRIBUTING.md in subfolder * multi-site setup * changes site_dir * revert * adding mkdoc-wrapper.sh * removing mkdocs from prod-requirements * more docs * fix test ... no more warning
2021-11-24 18:37:46 +01:00
- Operating Guide:
- connect-your-node.md
- daemon.md
Feature: Send dialog refactored and sped up (#1454) * Feature: time measuring for RPC-tracing * Performance warnings and hints * adjust treshold to 7 seconds * refactor api wallets endpoints to own file * more consistent error-handling * fee endpoint * refactoring tx-table to hide columns and add customaction * replace coin_selection with webcomponent * fix fee-test * fix fee-test * fix fee-estimation * fee selection web-component * bugfixes * fix test * using events to communicate changes * tidy up * fix selectedCoins * fix tests * no fee_rate calc in send_new endpoint and GET for fetchAssetBalances * refactor estimate_fee out from send_new * fix assetLabel * Do not use assetBalances-endpoint but pass as property * Typos corrected, RBF functionality restored, bugs in fee selection fixed and fee default settings improved. Co-authored-by: moneymanolis <moneymanolis@protonmail.com> Co-authored-by: Manolis <70536101+moneymanolis@users.noreply.github.com>
2022-01-13 09:38:44 +01:00
- performance.md
Documentation: hosted at docs.specter.solutions (#1463) * mkdocs * adding mkdocs for netlify * fix theme * link to Readme * deleting symlink again * deleting index.md * fix release-notes * several doc improvements and elements installation * move DEVELOPMENT.md and CONTRIBUTING.md in subfolder * multi-site setup * changes site_dir * revert * adding mkdoc-wrapper.sh * removing mkdocs from prod-requirements * more docs * fix test ... no more warning
2021-11-24 18:37:46 +01:00
- reverse-proxy.md
- self-signed-certificates.md
- hwibridge.md
- elements.md
- windows.md
Documentation: added endless pacman troubleshooting Guide (#1498) * added endless pacman * Revision of endless pacman documentation. Co-authored-by: moneymanolis <moneymanolis@protonmail.com>
2022-01-24 10:41:15 +01:00
- 'Endless Pacman Troubleshooting': endless-pacman.md
Documentation: hosted at docs.specter.solutions (#1463) * mkdocs * adding mkdocs for netlify * fix theme * link to Readme * deleting symlink again * deleting index.md * fix release-notes * several doc improvements and elements installation * move DEVELOPMENT.md and CONTRIBUTING.md in subfolder * multi-site setup * changes site_dir * revert * adding mkdoc-wrapper.sh * removing mkdocs from prod-requirements * more docs * fix test ... no more warning
2021-11-24 18:37:46 +01:00
- Development:
- 'Contributing': contributing.md
- 'Developing': development.md
Documentation: Create document for testing-setups and cleaning up swan (#1526) * testing env setup markdown * make service-list more resilient * tiny bit more logging in case of issues. * Swan api firewall fix * Restoring lost services-related code in wallets_api.py; bugfix on service_data mismatch * Bugfix on updated completed autowithdrawal addr labels * publish markdown on doc-page Co-authored-by: benk10 <ben.kaufman10@gmail.com> Co-authored-by: kdmukai <kdmukai@gmail.com> Co-authored-by: moneymanolis <moneymanolis@protonmail.com>
2022-01-17 18:33:33 +01:00
- 'Testing': test-new-releases.md
Documentation: hosted at docs.specter.solutions (#1463) * mkdocs * adding mkdocs for netlify * fix theme * link to Readme * deleting symlink again * deleting index.md * fix release-notes * several doc improvements and elements installation * move DEVELOPMENT.md and CONTRIBUTING.md in subfolder * multi-site setup * changes site_dir * revert * adding mkdoc-wrapper.sh * removing mkdocs from prod-requirements * more docs * fix test ... no more warning
2021-11-24 18:37:46 +01:00
- build-instructions.md
- 'Continuous Integration': continuous-integration.md
- cypress-testing.md
Feature: Service integration - Swan (#1517) * fix create_order issue * fix url and better error-handling * basic balances tab * activating services * Service management * Improve settings page and default to it if token unset * Fix history tab * Fix trade error handling * Add withdraw * calling specter-cloud for creating vaultoro orders * Improve trade screen and fixes * sidebar fix * black * refactor Service integration * refactor to have Service Classes like manifests * maturity * dynamic initialisation of service-classes and blueprints * fix sidebar_services * migrated templates and static into vaultoro folder * refactor config to manifest * some minor things * swan initial * rename and fix test * adding ServiceApiKeyStorageUserAware * fix * store the access token * directory indirection to shield templates from each others blueprint * first attempts with automatic withdrawals * proper tab highlighting * Update service_apikey_storage.py * Update oauth2_success.jinja * Awaiting refresh_token support * Service logo display on Addresses * Associate addr with a Service * address-data component reorg Separates the presentation html from the data as much as possible. * Services data/icon added to tx History * Now hitting the updated Swan endpoint to save deposit addrs * Simplified injecting Services data into JS * Reducing js calls back to server in tx-data; templatizing utxo in/outs * renaming "reserving" to "associating" an Address with a Service. * rename `manifest.py` files to `service.py`. * rename "api_data" to "service_data" to make the storage a bit more generalized. `ServiceApiKeyStorage` is now `ServiceEncryptedStorage` to match. * Beginning of factoring out Swan api to its own `api.py` file; need to rectify with `swan_client.py`. * Removed tx-table/row/data changes and address-table/row/data Kept only the bare minimum changes required to display the Services icon, plus optimizations. * deleted no longer used CustomElement * Adding services docs to mkdocs * Configuration for Services * more clever configuration * fix test * deleted swan_client * Changing the address abbreviation format to 7...7 and little big fix for not vertically aligned addresses in Firefox. * Better state management if Auth method changes * Cleanup, better user messaging; pulling Service methods out of controller and User * Redirect to services endpoint after setting up authentication. * PR cleanup, bug fixes, test suite updates * Fixed test case problem * First fix for delete API key button. * Service hooks; Option to fully remove Swan Integration; Logout clears plaintext_user_secret * Restoring bugfix from @moneymanolis * cleanup and black * Make service-decovery in AppImage work * import hashlib, maybe fix cypress * Update service_encrypted_storage.py * further bugfix on update * TODO: remove debugging in client.py before first release * fix controller-test * fix singleton testing issues Co-authored-by: Kim Neunert <k9ert@gmx.de> Co-authored-by: benk10 <ben.kaufman10@gmail.com> Co-authored-by: Kim Neunert <kneunert@gmail.com> Co-authored-by: moneymanolis <moneymanolis@protonmail.com>
2022-01-13 04:47:28 -06:00
- services/services.md
Docs: Architectural Notes (#1673) * Docs: Architectural Notes * including Service Diagram * minor changes
2022-04-25 15:56:57 +02:00
- 'Architectural Notes': architecture.md
Documentation: hosted at docs.specter.solutions (#1463) * mkdocs * adding mkdocs for netlify * fix theme * link to Readme * deleting symlink again * deleting index.md * fix release-notes * several doc improvements and elements installation * move DEVELOPMENT.md and CONTRIBUTING.md in subfolder * multi-site setup * changes site_dir * revert * adding mkdoc-wrapper.sh * removing mkdocs from prod-requirements * more docs * fix test ... no more warning
2021-11-24 18:37:46 +01:00
- '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
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
plugins:
- 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"
Reference in a new issue Copy permalink