Skip to content

rdt-model-docs

rdt-model-docs generates reference documentation pages for the Starlight site. It reads from committed repository artifacts — models, data contracts, ADRs, platform status — and produces Markdown pages in docs/src/content/docs/reference/.

This module generates reference content only. Hand-authored content (overview, architecture, module user manuals, guides) is maintained separately and is not touched by this generator.

Helper module — runs standalone or as a post-pipeline CI step.

Terminal window
# Generate reference documentation
cargo run -p rdt-model-docs -- --target dev generate

No external credentials required. Reads from the local repository only.

Reads committed artifacts. No pipeline dependency — can run at any time.

DirectoryOwner
docs/src/content/docs/overview/Hand-authored
docs/src/content/docs/architecture/Hand-authored
docs/src/content/docs/modules/Hand-authored
docs/src/content/docs/guides/Hand-authored
docs/src/content/docs/reference/This module — do not hand-edit
FileFormatDescription
docs/src/content/docs/reference/*.mdMarkdownGenerated entity reference pages, ADR summaries, platform status