-
Notifications
You must be signed in to change notification settings - Fork 0
π Documentation drift detected β missing configure command + undocumented source filesΒ #116
Description
Documentation Freshness Audit
The weekly documentation audit found the following inconsistencies between code and documentation:
Findings
| Area | Issue | File(s) |
|---|---|---|
| Architecture tree | src/configure.rs and src/detect.rs are not listed |
AGENTS.md lines 21β61 |
| CLI Commands | configure subcommand is entirely absent |
AGENTS.md lines 708β733, README.md lines 382β390 |
| CLI Commands | compile (path) documents path as required, but it is optional with auto-discovery |
AGENTS.md line 716 |
Details
1. Missing source files in architecture tree
AGENTS.md lists the project source tree, but two files that exist on disk are absent:
src/configure.rsβ implements theconfigureCLI command (detects agentic pipelines and updatesGITHUB_TOKENon their ADO build definitions)src/detect.rsβ pipeline auto-detection logic used by bothconfigureandcompile
2. Undocumented configure subcommand
src/main.rs defines a Configure variant in the Commands enum (line 84β106), but it does not appear anywhere in the CLI Commands section of AGENTS.md or in the README.md command listing. The command has the following flags:
configure
--token The new GITHUB_TOKEN value (defaults to $GITHUB_TOKEN env var)
--org Override ADO organization URL (inferred from git remote by default)
--project Override ADO project name (inferred from git remote by default)
--pat PAT for ADO API auth (prefer $AZURE_DEVOPS_EXT_PAT env var)
--path Path to repository root (defaults to current directory)
--dry-run Preview changes without applying them
--definition-ids Explicit pipeline definition IDs to update (comma-separated)
3. compile (path) β optional path not reflected in docs
AGENTS.md documents the command as compile (path), implying the path is required. In src/main.rs (lines 33β40), path is Option(String) with the comment: "If omitted, auto-discovers and recompiles all existing agentic pipelines in the current directory." The docs should reflect this optional behavior.
Suggested Fixes
- Add
src/configure.rsandsrc/detect.rs(with short descriptions) to the architecture tree inAGENTS.md - Document the
configuresubcommand in the CLI Commands section ofAGENTS.mdwith all its flags and a short description of its purpose - Add
configureto the command listing inREADME.md - Update
compile (path)inAGENTS.mdtocompile [path]and note the auto-discovery behavior when path is omitted
This issue was created by the automated documentation freshness check.
Generated by Documentation Freshness Check Β· β·