Expand description
Deterministic documentation governance for AI-assisted software teams.
docpact is primarily a CLI. Repositories describe documentation
obligations in .docpact/config.yaml; commands such as lint, route,
freshness, and render evaluate those rules from explicit inputs.
The crate intentionally keeps enforcement deterministic. It does not use an LLM to decide whether documentation is stale, and it does not hide state in background services or opaque caches. Automation can rely on repeatable reports, diagnostics artifacts, and CI exit codes.
Most users should start with the CLI. Library APIs are currently organized around the same command implementations and report structures that power the command-line interface.
Modules§
- baseline
- Baseline support for suppressing existing diagnostics during adoption.
- check
- Diff-driven linting for required documentation review and update checks.
Implementation of
docpact lint. - cli
- Command-line argument definitions and shared CLI enums.
CLI argument definitions for the
docpactbinary. - config
- Configuration loading, inheritance, validation, and path normalization.
- coverage
- Coverage audits for governed paths and reachable documentation inventory. Implementation of governance coverage audits.
- diagnostics
- Report-backed diagnostics drill-down.
- doctor
- Repository health checks for configuration and governance setup.
- explain
- Rule-match explanation for individual paths.
- freshness
- Freshness audits for governed documents and review references. Implementation of document freshness checks.
- git
- Git helpers used by diff, history, and tracked-path commands.
- list_
rules - Rule listing and inspection output.
- metadata
- Review metadata parsing and update helpers.
- render
- Read-only derived views over catalog, ownership, routing, and navigation. Implementation of read-only derived render views.
- reporters
- Text, JSON, and SARIF report builders.
- review
- Review evidence commands for marking documents as reviewed.
Implementation of
docpact review. - route
- Reading-route recommendations for paths, modules, and controlled intents.
Implementation of
docpact route. - rules
- Trigger matching and required-document rule primitives.
- validate_
config - Configuration validation command implementation.
- waiver
- Waiver lifecycle support for explicit temporary exceptions.