Skip to content

Add Documentation Quadrant (Diátaxis framework) to mkdocs - #435

Draft
richardkiss with Copilot wants to merge 3 commits into
mainfrom
copilot/port-documentation-to-mkdocs
Draft

Add Documentation Quadrant (Diátaxis framework) to mkdocs#435
richardkiss with Copilot wants to merge 3 commits into
mainfrom
copilot/port-documentation-to-mkdocs

Conversation

Copilot AI commented Feb 28, 2026

Copy link
Copy Markdown
Contributor

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 → ku CLI
  • first-transaction.md — Coinbase tx → spendables → unsigned tx → sign → serialize

How-to Guides (docs/how-to/)

  • bip32-keys.md — Seed → xprv/xpub export, child derivation, public-only (watch-only) wallets, BIP44/49/84 paths
  • sign-a-transaction.md — Single WIF, multi-WIF, BIP32 node, Keychain, create_signed_tx, partial multisig, GPG-encrypted key files via tx CLI
  • multisig.md — Full 2-of-3 walkthrough: keys → redeem script → P2SH address → fund → incremental signing → who_signed

Reference

  • cmdtools.md — Replaced one-line stub with complete ku + tx reference: all options, env vars, and annotated examples (inlined from COMMAND-LINE-TOOLS.md)

Explanation (docs/explanation/)

  • design-philosophy.md — Network-centric API model, pycoin vs Satoshi naming conventions (puzzle_script/solution_script vs scriptPubKey/scriptSig), key class hierarchy, multi-network support, ECDSA acceleration backends

Navigation

  • mkdocs.yml nav restructured into four labelled sections matching the quadrants
  • docs/index.md replaced 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.

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
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants