Documentation Freshness Audit
This audit compared the project documentation against the actual codebase across all documentation files (AGENTS.md, docs/*.md, README.md, prompts/create-ado-agentic-workflow.md).
Findings
| Area |
Issue |
File(s) |
| CLI docs index |
enable subcommand missing from the docs/cli.md reference entry |
AGENTS.md line 214 |
Details
The docs index in AGENTS.md describes each docs file with a brief summary including notable items. The entry for docs/cli.md listed all CLI subcommands except enable:
- `docs/cli.md` — `ado-aw` CLI commands (`init`, `compile`,
`check`, `mcp`, `mcp-http`, `execute`, `configure`).
The enable command registers ADO build definitions for compiled pipelines, is fully implemented in src/enable.rs, and is completely documented in docs/cli.md. It is also correctly listed in the README.md CLI reference. Only the AGENTS.md docs index entry was stale.
An AI agent navigating the codebase via AGENTS.md could conclude that docs/cli.md only covers the listed commands, causing it to overlook enable when reasoning about the CLI surface.
Other areas checked and found accurate:
- Architecture section (
AGENTS.md) — all source files match the directory tree
- Front matter fields (
docs/front-matter.md, README.md) — all FrontMatter struct fields correctly documented
- Template markers (
docs/template-markers.md) — all \{\{ markers }} in data templates match docs
- Safe output tools (
docs/safe-outputs.md) — all tools in src/safeoutputs/ documented
- Schedule syntax (
docs/schedule-syntax.md, prompt) — matches src/fuzzy_schedule.rs
- Network domains (
docs/network.md) — matches src/allowed_hosts.rs
- Pool defaults —
vmImage: ubuntu-22.04 correctly documented everywhere
- Default model —
claude-opus-4.7 matches DEFAULT_COPILOT_MODEL in src/engine.rs
prompts/create-ado-agentic-workflow.md — all front matter fields, models, and schedule syntax accurate
Applied Fixes
This pull request was created by the automated documentation freshness check.
To route changes like this to a review issue instead of blocking, configure protected-files: fallback-to-issue in your workflow configuration.
Generated by Documentation Freshness Check · ● 4.7M · ◷
Documentation Freshness Audit
This audit compared the project documentation against the actual codebase across all documentation files (
AGENTS.md,docs/*.md,README.md,prompts/create-ado-agentic-workflow.md).Findings
enablesubcommand missing from thedocs/cli.mdreference entryAGENTS.mdline 214Details
The docs index in
AGENTS.mddescribes each docs file with a brief summary including notable items. The entry fordocs/cli.mdlisted all CLI subcommands exceptenable:The
enablecommand registers ADO build definitions for compiled pipelines, is fully implemented insrc/enable.rs, and is completely documented indocs/cli.md. It is also correctly listed in theREADME.mdCLI reference. Only the AGENTS.md docs index entry was stale.An AI agent navigating the codebase via
AGENTS.mdcould conclude thatdocs/cli.mdonly covers the listed commands, causing it to overlookenablewhen reasoning about the CLI surface.Other areas checked and found accurate:
AGENTS.md) — all source files match the directory treedocs/front-matter.md,README.md) — allFrontMatterstruct fields correctly documenteddocs/template-markers.md) — all\{\{ markers }}in data templates match docsdocs/safe-outputs.md) — all tools insrc/safeoutputs/documenteddocs/schedule-syntax.md, prompt) — matchessrc/fuzzy_schedule.rsdocs/network.md) — matchessrc/allowed_hosts.rsvmImage: ubuntu-22.04correctly documented everywhereclaude-opus-4.7matchesDEFAULT_COPILOT_MODELinsrc/engine.rsprompts/create-ado-agentic-workflow.md— all front matter fields, models, and schedule syntax accurateApplied Fixes
enableto the CLI commands list in thedocs/cli.mdindex entry inAGENTS.mdThis pull request was created by the automated documentation freshness check.
Warning
Protected Files
This was originally intended as a pull request, but the patch modifies protected files. These files may affect project dependencies, CI/CD pipelines, or agent behaviour. Please review the changes carefully before creating the pull request.
Click here to create the pull request once you have reviewed the changes
Protected files
AGENTS.mdTo route changes like this to a review issue instead of blocking, configure
protected-files: fallback-to-issuein your workflow configuration.