Add Documentation Quadrant (Diátaxis framework) to mkdocs - #435
Draft
richardkiss with Copilot wants to merge 3 commits into
Draft
Add Documentation Quadrant (Diátaxis framework) to mkdocs#435richardkiss with Copilot wants to merge 3 commits into
richardkiss with Copilot wants to merge 3 commits into
Conversation
Co-authored-by: richardkiss <5336+richardkiss@users.noreply.github.com>
Copilot
AI
changed the title
[WIP] Port documentation to mkdocs and rewrite to markdown
Port documentation from RST/Sphinx to MkDocs + Markdown
Feb 28, 2026
Co-authored-by: richardkiss <5336+richardkiss@users.noreply.github.com>
Copilot
AI
changed the title
Port documentation from RST/Sphinx to MkDocs + Markdown
Add Documentation Quadrant (Diátaxis framework) to mkdocs
Mar 1, 2026
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
The docs were ported to mkdocs but lacked real content across all four documentation types. This PR flushes out the Diátaxis quadrant — Tutorials, How-to Guides, Reference, and Explanation — with substantive new pages.
Tutorials (
docs/tutorials/)getting-started.md— Install → create a key → derive an address → BIP32 →kuCLIfirst-transaction.md— Coinbase tx → spendables → unsigned tx → sign → serializeHow-to Guides (
docs/how-to/)bip32-keys.md— Seed → xprv/xpub export, child derivation, public-only (watch-only) wallets, BIP44/49/84 pathssign-a-transaction.md— Single WIF, multi-WIF, BIP32 node,Keychain,create_signed_tx, partial multisig, GPG-encrypted key files viatxCLImultisig.md— Full 2-of-3 walkthrough: keys → redeem script → P2SH address → fund → incremental signing →who_signedReference
cmdtools.md— Replaced one-line stub with completeku+txreference: all options, env vars, and annotated examples (inlined fromCOMMAND-LINE-TOOLS.md)Explanation (
docs/explanation/)design-philosophy.md— Network-centric API model, pycoin vs Satoshi naming conventions (puzzle_script/solution_scriptvsscriptPubKey/scriptSig), key class hierarchy, multi-network support, ECDSA acceleration backendsNavigation
mkdocs.ymlnav restructured into four labelled sections matching the quadrantsdocs/index.mdreplaced with a quadrant overview table and quick-start snippet🔒 GitHub Advanced Security automatically protects Copilot coding agent pull requests. You can protect all pull requests by enabling Advanced Security for your repositories. Learn more about Advanced Security.