Skip to main content

Crate spec_driven_docs

Crate spec_driven_docs 

Source
Expand description

Spec-driven documentation: current specs, immutable decision records, and executable gates kept coherent for people and coding agents.

This crate is the canon’s distribution: the sdd binary installs, verifies, upgrades, and gates instances, and carries the whole payload — spec seeds, templates, lint configs, and the method chapters — embedded at compile time. The method itself lives in the repository’s markdown, not here; this crate only ships and enforces it.

Major modules:

  • domain — pure types and invariants: manifest, profiles, rule and gate identifiers, marker-block splicing, versions.
  • embedded — every compile-time embedded asset and its accessors.
  • gates — the delivered gate implementations and their registry.
  • services — install, verify, upgrade, and hook-rendering orchestration.
  • adapters — filesystem I/O at the edges.
  • cli / commands — clap parse shapes and their handlers.
  • errorerror::AppError and the exit-code matrix.

Modules§

adapters
I/O at the edges.
cli
Root clap parser.
commands
Subcommand handlers.
context
Shared per-invocation context handed to every command handler.
domain
Pure domain types and invariants.
embedded
Compile-time embedded assets: the payload and the method, in the binary.
error
Crate-level error type and exit-code mapping.
gates
The delivered gates: every check an instance wires as a pre-commit hook.
logging
tracing-subscriber installation. Called once from main.
output
The output boundary: every byte the binary prints goes through here.
payload_roots
probes
The environment probe catalog.
services
Orchestration services: the work behind the lifecycle commands.