Skip to content

docs: one mdbook for wallet developers, operators & contributors - #19

Merged
elicbarbieri merged 2 commits into
mainfrom
docs/book
Nov 12, 2026
Merged

elicbarbieri merged 2 commits into
mainfrom
docs/book

Conversation

@elicbarbieri

@elicbarbieri elicbarbieri commented Nov 12, 2026 •

Copy link
Copy Markdown
Collaborator

moves every doc outside the crates into one mdbook published to github pages: a part each for wallet devs, operators & contributors. docs/ is gone.

What it does

  • book/: mdbook, three parts
    • wallets: connecting, methods (only where zingod goes beyond the protos or differs from lightwalletd), status codes, protocol files (service.proto & compact_formats.proto included from zingod-proto, not copied)
    • operators: quick start, configuration (annotated zingod.toml included), first sync, monitoring, maintenance, network exposure, docker, migrating from zaino; example configs live here
    • contributors: architecture, what wallets call, testing, updating zebra (moved from docs/)
  • removes docs/; running.md & rpc_api.md split across the book
  • operator-facing bits of crate guides (logging, overload causes, serving log, alarms) move to the book; guides link there
    • "answered by" table moves from rpc_api.md to zingod-grpc/usage.md
  • every docs/... reference (guides, CLAUDE.md, code comments) repointed into book/src/
    • code: comment paths only, plus the example-config include_str! path in config.rs
  • README trimmed to pitch + links
  • .github/workflows/book.yml: builds on PRs, deploys from main; mdbook in the devshell

notes:

  • needs repo settings → pages → source = github actions before the first deploy
  • stacked on feat/origin-policy (documents its origin policy / gRPC-web); retarget to main once that lands
  • preview: mdbook serve book --open

🤖 Generated with Claude Code

@elicbarbieri elicbarbieri changed the title docs: mdbook for wallet developers & operators docs: one mdbook for wallet developers, operators & contributors Nov 12, 2026
@elicbarbieri
elicbarbieri changed the base branch from main to feat/origin-policy November 12, 2026 19:41
@elicbarbieri
elicbarbieri added this pull request to stack #20 November 12, 2026 19:52
Base automatically changed from feat/origin-policy to main November 12, 2026 22:43
elicbarbieri and others added 2 commits November 12, 2026 14:43
… contributors

Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
@elicbarbieri
elicbarbieri merged commit 3664ce0 into main Nov 12, 2026
5 checks passed
@elicbarbieri
elicbarbieri deleted the docs/book branch November 12, 2026 22:51
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.

1 participant