Skip to main content

Crate atune_dev

Crate atune_dev 

Expand description

atune_dev — the repository’s own developer tool, reached as cargo dev.

It writes the generated reference pages and, in --mode check, fails when one has drifted from the code it describes (D29, docs/design/11-documentation-plan.md §7). Drift is a red build, not a stale page:

cargo dev generate-all --mode write     # regenerate (developer)
cargo dev generate-all --mode check     # fail on drift (CI)
cargo dev generate-all --mode dry-run   # print to stdout

The crate is publish = false and is never a dependency of anything shipped.

Modules§

check_api_links 🔒
cargo dev check-api-links — every link in the map resolves to a real page.
check_guide_links 🔒
cargo dev check-guide-links — G15: every guide citation names a live page.
check_lints 🔒
cargo dev check-lints — the one crate that cannot inherit the workspace lints still enforces every one of them.
error 🔒
The tool’s error type.
generate_all 🔒
generate-all: the list of generated pages, and the driver over it.
generated_doc 🔒
The GeneratedDoc contract, and the pragma splice that enforces it.
generators 🔒
The generators themselves — one module per page.
markdown 🔒
Turning documentation written for another reader into Markdown.
parity 🔒
The cross-language parity gate (D26, docs/design/11-documentation-plan.md §6.2), and the runner that keeps every example executed.
rust_source 🔒
Reading the workspace’s own Rust sources as a registry.

Structs§

Dev 🔒
The developer tool’s command line.

Enums§

Task 🔒
The tasks.

Functions§

main 🔒