book: Documentation gap analysis for the 1.0.0 release (tracking)

[pacu]

This issue tracks the documentation gaps identified in a code/book/issue-tracker analysis ahead of the Zallet 1.0.0 release, and collects the scoped issues created from it. It complements #182 (zcashd migration documentation), which remains the tracking issue for migration-specific docs.

Summary of the analysis

Code documentation (rustdoc): missing_docs is enforced across the workspaces and the tree compiles with zero warnings, so nominal coverage is complete. The doc-from-code pipeline is healthy: config rustdoc generates zallet example-config output (trycmd-tested), and the RPC trait rustdoc generates zallet rpc help and the rpc.discover OpenRPC document. Remaining gaps are (a) rustdoc is built in CI only for link-checking and never published anywhere, and (b) crate/module-level architecture docs are thin.

The Zallet Book: The existing pages (setup, CLI reference, altered JSON-RPC semantics, installation, SLSA) are accurate and reasonably deep. The structural gaps:

• No JSON-RPC method reference (35 methods are implemented and documented in code, but invisible to anyone without a running wallet).
• No complete zcashd→Zallet RPC status matrix (the "omitted methods" table covers part of it; several rows lack replacement guidance).
• The configuration reference shows only the first 25 of 360 generated example-config lines.
• No Concepts section (account model, key material and encryption model, note management / confirmation policy, fees).
• No backup & restore guide (the only guidance is a warning box in the migrate-zcashd-wallet page).
• No operations guide (logging, monitoring, deployment, shutdown) and no Docker installation page despite an official image.
• The setup guide stops at zallet start; a new user is never shown how to create an account, receive, or send.
• book/src/zcashd/README.md ("Migrating from zcashd") is a literal TODO — tracked by Document migration strategies for zcashd wallet users #182.
• A few factual bugs (backend named zebra-state in the book vs zebra in the launcher; stale site-url/links).

Principles for addressing these (from team discussion): documentation must be fact-based — generated from code where possible, citing ZIPs for protocol semantics rather than restating them — and concise enough to actually be read (by humans and LLMs alike).

Scoped issues

(To be checked off as they land.)

• book: Add a JSON-RPC method reference generated from the OpenRPC document #601 — book: JSON-RPC method reference generated from the OpenRPC document
• book: Add a zcashd→Zallet RPC migration status matrix #602 — book: zcashd→Zallet RPC migration status matrix
• book: Render the full generated example config as a configuration reference #603 — book: full configuration reference from generated example config
• book: Add a Concepts section (accounts, keys & encryption model, notes, fees) #604 — book: Concepts section
• book: Add a backup and restore guide #605 — book: backup & restore guide
• book: Add an operations guide (logging, deployment, monitoring, shutdown) #606 — book: operations guide
• book: Document Docker-based installation #607 — book: Docker-based installation
• book: Extend the setup guide into an end-to-end first-wallet tutorial #608 — book: end-to-end first-wallet tutorial
• docs: Publish rustdoc and expand crate/module-level architecture docs #609 — docs: publish rustdoc + expand architecture-level docs
• book: Add a troubleshooting page #610 — book: troubleshooting page
• book: Fix incorrect backend name zebra-state and stale book URLs #611 — book: fix backend name and stale URLs

---

Analysis and issue drafting done with AI assistance (Claude); facts verified against the code at 29bb94a.

[linear]

COR-1565