Documentation Freshness Audit
This audit found the following inconsistencies between code and documentation:
Findings
| Area |
Issue |
File(s) |
| Target field documentation |
target: field only listed standalone and 1es as valid values, but compiler also supports job and stage |
README.md, AGENTS.md, prompts/create-ado-agentic-workflow.md |
Details
The compiler defines four valid CompileTarget values in src/compile/types.rs:
standalone — full 3-job pipeline (default)
1es — 1ES Pipeline Template integration
job — reusable jobs:-root ADO template (src/compile/job.rs, src/data/job-base.yml)
stage — reusable stages:-root ADO template (src/compile/stage.rs, src/data/stage-base.yml)
docs/targets.md and docs/front-matter.md correctly document all four values. However, three other docs only mentioned two:
- README.md line 238: Front Matter Fields table showed
standalone | 1es only
- AGENTS.md line 196–197:
docs/targets.md link description read "target platforms: standalone and 1es"
- prompts/create-ado-agentic-workflow.md Step 7: Target table only had
standalone and 1es rows — agents following this prompt would never produce target: job or target: stage pipelines
The third finding is particularly high-priority: prompts/create-ado-agentic-workflow.md is the primary guide AI agents use when creating new workflow files. Missing job/stage from the target table means any agent following this prompt would never know these are valid options.
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.2M · ◷
Documentation Freshness Audit
This audit found the following inconsistencies between code and documentation:
Findings
target:field only listedstandaloneand1esas valid values, but compiler also supportsjobandstageREADME.md,AGENTS.md,prompts/create-ado-agentic-workflow.mdDetails
The compiler defines four valid
CompileTargetvalues insrc/compile/types.rs:standalone— full 3-job pipeline (default)1es— 1ES Pipeline Template integrationjob— reusablejobs:-root ADO template (src/compile/job.rs,src/data/job-base.yml)stage— reusablestages:-root ADO template (src/compile/stage.rs,src/data/stage-base.yml)docs/targets.mdanddocs/front-matter.mdcorrectly document all four values. However, three other docs only mentioned two:standalone | 1esonlydocs/targets.mdlink description read "target platforms:standaloneand1es"standaloneand1esrows — agents following this prompt would never producetarget: jobortarget: stagepipelinesThe third finding is particularly high-priority:
prompts/create-ado-agentic-workflow.mdis the primary guide AI agents use when creating new workflow files. Missingjob/stagefrom the target table means any agent following this prompt would never know these are valid options.Applied Fixes
targetfield type column tostandalone | 1es | job | stagewith a note thatjob/stagegenerate reusable ADO templatesdocs/targets.mdlink description to mention all four targetsjobandstagerows to the target table; updated the preamble from "Only include if using 1ES Pipeline Templates" to the more accurate "Only include if using a different target"; added a note about trigger-ignore behaviour and job-name prefixing for template targetsThis 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.