The protocol docs and the guide (this document) are built using
mdBook and auto-deployed on pushes to
main. To build locally:
- Install the requirements:
cargo install mdbook mdbook-katex mdbook-mermaid
docs/protocol(for the protocol spec) or from
docs/guide(for this document).
The Rust API docs can be built with
The landing page, the top-level
index.html, is handled as a special case.
If you added new crates by appending a
-p <crate_name> to the
then you must rebuild the index page via:
CI will automatically rebuild all our docs on merges into main, except for the Rust doc index.html, which must be updated manually.