Keyboard shortcuts

Press ← or → to navigate between chapters

Press S or / to search in the book

Press ? to show this help

Press Esc to hide this help

Local Documentation Build

The local documentation build assembles the narrative mdBook and workspace rustdoc into one channel-shaped site tree.

From the repository root:

docs/scripts/build-local-docs.sh

The default channel is dev, and the generated site is written to:

target/docs/site/dev/

Open target/docs/site/dev/index.html in a browser to inspect the assembled site. Set DOCS_CHANNEL to build a different local channel name:

DOCS_CHANNEL=stable docs/scripts/build-local-docs.sh

Prerequisites:

  • mdbook
  • jq
  • the Rust toolchain configured by this workspace
  • native build dependencies needed by the workspace crates

Install mdBook with Cargo when it is not already available:

cargo install mdbook

The local build does not publish anything and does not require live PostgreSQL, OAuth, DuckLake, HDSS, REDCap, or browser-auth services.

See the documentation and CI controls for DOCS_CHANNEL and other documentation/CI controls.