Skip to content

docs: fix documentation drift — enable command missing from CLI docs index #603

@github-actions

Description

@github-actions

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

  • Added enable to the CLI commands list in the docs/cli.md index entry in AGENTS.md

This 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.md

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 ·

Metadata

Metadata

Assignees

No one assigned

    Type

    No type
    No fields configured for issues without a type.

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions