Skip to content

docs: fix documentation drift — add job and stage targets to README, AGENTS.md, and create prompt #547

@github-actions

Description

@github-actions

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:

  1. README.md line 238: Front Matter Fields table showed standalone | 1es only
  2. AGENTS.md line 196–197: docs/targets.md link description read "target platforms: standalone and 1es"
  3. 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

  • README.md: Expanded target field type column to standalone | 1es | job | stage with a note that job/stage generate reusable ADO templates
  • AGENTS.md: Updated docs/targets.md link description to mention all four targets
  • prompts/create-ado-agentic-workflow.md Step 7: Added job and stage rows 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 targets

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.2M ·

Metadata

Metadata

Assignees

No one assigned

    Labels

    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