choir documentation

Getting started lives in the top-level README. Everything else is here, indexed by what you are trying to do.

Every page here is also compiled into the API documentation: each one is pulled into the crate that implements it with #![doc = include_str!], so cargo doc renders this prose beside the types it describes. That is not a convenience — it is what keeps these pages honest. The release gate runs cargo doc with -D warnings, so a Rust example in any of these files that stops compiling fails the build.

API documentation →

Build both halves together with choir docs, which renders the book and puts rustdoc inside it at /api/. From a checkout without the CLI installed: cargo run -p choir-cli -- docs --open.

The comment above is a marker, not stray markup: choir docs replaces it with a link to the node when the publishing workflow supplies that address (D76).

Start here

Operating a node

Two runbooks sit beside these, for the two operations that are procedures rather than configuration:

• Private single-node beta runbook — the network hold, the TLS proxy, backups, staging promotion, go-live receipts.
• Restoring a node from a backup — the ordering rule, and the secrets a backup deliberately never holds.
• Canonical-node flip runbook — supervised install and turning on the protected-ref gates.

Using a node

Reference

Which of these is generated

Editing a generated file by hand is wasted work: the release gate compares it against its source and fails when they differ. Regenerate with cargo run -p choir-cli --example gen-surface.

Everything else on this page is written by hand and is fair game to edit.