- 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:
You’ll need to use the
nightly toolchain for Rust to build the docs. In some cases, you’ll need
a specific version. To configure locally:
rustup toolchain install nightly-2023-05-15
CI will automatically rebuild all our docs on merges into main.