-
Notifications
You must be signed in to change notification settings - Fork 39
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
release-24.07.0 docs changes only #413
Conversation
Codecov ReportAll modified and coverable lines are covered by tests ✅
Additional details and impacted files@@ Coverage Diff @@
## release-24.07.0 #413 +/- ##
================================================
Coverage 94.64% 94.64%
================================================
Files 57 57
Lines 7073 7073
================================================
Hits 6694 6694
Misses 379 379 ☔ View full report in Codecov by Sentry. |
Thank you Jean!
I fixed many broken anchors created by the faq->troubleshooting migration, mkdocs caught most, but as links in "snippets" are absolute it just warns about being absolute, I can fix that.
Will fix too
Should we add Coldcard or remove all?
I believe math expressions will render in Github pages, but I'll look for tools to render it locally too.
Great, I'll go through your todo list while you review those |
I don't have an opinion on links to other sites, except that they might be consistent. seedsigner has links in the SeedQR sections for understanding that format. Since verification is important for everyone, we could have links to non-competing projects (like seedtool and iancoleman), otherwise if we're going to have links to some, we might as well link all of the signers that we mention. Self-custody bitcoin-nation is the next global empire, we're all on the same team! |
Right, let's include it! We don't have any competing projects. Indeed, the greater the number of verification options, the better! |
Thank you! |
Description
These are just my thoughts on improvements to documentation, however when considering to merge these, please feel free to add commits, backing-out any of these changes, else ask me and I will adjust via more commits.
STILL TODO:many pages expect an anchor to explain adjusting the amigo screen be explained at /krux/faq/#troubleshooting-lcd-settings-on-maix-amigo however this section does not exist in the faq, this needs to be written or perhaps it already exists elsewhere?/krux/getting-started/installing/from-test-release/ needs a section for manual install via ktool for the maixpy_cubeSince I don't have a "cube", can someone please verify?I noticed links to seedsigner.com and bitcoiner.guide at the bottom of krux/getting-started/usage/generating-a-mnemonic but I didn't notice one for coldcard (rethink external links?)When viewing docs viapoetry run poe docs
, the math expressions in /krux/getting-started/features/entropy are not nearly as pretty as they appear on github sites... confirm that this is expected, else to be fixed. (they're often wrapped in what looks like single or double dollar-signs.)This pr covers my review of all docs
EXCEPT documentation related to setting up single-sig and multisig wallets in coordinators... but I will get around to reviewing that too.I'll note that Nunchuk, a nice mobile coordinator option, is not at all documented. To consider, would it be sufficient to have a list of external video links by educators who do such a great job of teaching users how to use combinations of tools (signer and coordinator) so that docs could focus exclusively on krux???What is the purpose of this pull request?