Crates
DraftThe item-level reference for every Rust crate in the workspace is its rustdoc. The workspace is
publish = false, so docs.rs never builds it, and rustdoc renders a whole site of its own that is
far too large to commit. It is therefore the one reference surface that lives outside this site’s
chrome, as Developer Documentation records.
Where to get it
Section titled “Where to get it”- Locally:
cargo doc --workspace --no-deps --openbuilds it and opens it in a browser. Add--document-private-itemsto see what the gate sees. - From CI: the Rust gate builds it on every run (
mise run doc-check-rust, which denies broken and ambiguous intra-doc links over every item, private ones included). On each push tomaster, theRustjob uploads that build as therustdocworkflow artifact; download it from the run and open a crate’sindex.html, such ascapsule_sdk/index.html.
It is not hosted beside this site yet: publishing is still a manual bun run deploy, and
hosting rustdoc waits on deploy automation.
Which crate to start from
Section titled “Which crate to start from”Which crate owns which module, and which design doc owns each module’s contract, is the
Module Map. For a client, start from capsule-sdk, whose overview is the
Rust SDK page.