Skip to content

docs: fix documentation drift — duplicate ir/ tree in AGENTS.md, missing supply-chain field in README #1123

Description

@github-actions

Documentation Freshness Audit

This audit found the following inconsistencies between code and documentation:

Findings

Area Issue File(s)
Architecture tree src/compile/ir/ directory listed twice in the tree AGENTS.md
Front Matter Fields table supply-chain field missing README.md

Details

1. Duplicate ir/ directory in AGENTS.md architecture tree

The src/compile/ir/ directory appeared twice in the compile/ tree:

  • A first listing (middle of the tree) that included tasks/ but was missing summary.rs
  • A second listing (at the end of the tree) that included summary.rs but was missing tasks/

Neither listing was complete on its own. The fix removes the first (incomplete) listing and adds tasks/ to the second listing, resulting in a single complete entry covering all files: mod.rs, ids.rs, step.rs, tasks/, job.rs, stage.rs, env.rs, condition.rs, output.rs, graph.rs, lower.rs, emit.rs, and summary.rs.

2. supply-chain field missing from README.md Front Matter Fields table

The supply-chain front-matter field (SupplyChainConfig in src/compile/types.rs) has a dedicated docs page (docs/supply-chain.md) and is referenced in AGENTS.md and docs/front-matter.md, but was absent from the quick-reference table in README.md. The fix adds a row with a link to docs/supply-chain.md.

Applied Fixes

  • Remove duplicate src/compile/ir/ listing from AGENTS.md architecture tree; consolidate into one complete listing with tasks/ and summary.rs
  • Add supply-chain row to the Front Matter Fields table in README.md

This pull request was created by the automated documentation freshness check.


Warning

Protected Files — Push Permission Denied

This was originally intended as a pull request, but the patch modifies protected files. A human must create the pull request manually.

Protected files
  • AGENTS.md
  • README.md

The push was rejected because GitHub Actions does not have workflows permission to push these changes, and is never allowed to make such changes, or other authorization being used does not have this permission.

Create the pull request manually
# Download the patch from the workflow run
gh run download 27856018612 -n agent -D /tmp/agent-27856018612

# Create a new branch
git checkout -b docs/fix-documentation-drift-2446e07b17baa2f4 main

# Apply the patch (--3way handles cross-repo patches)
git am --3way /tmp/agent-27856018612/aw-docs-fix-documentation-drift.patch

# Push the branch and create the pull request
git push origin docs/fix-documentation-drift-2446e07b17baa2f4
gh pr create --title 'docs: fix documentation drift — duplicate ir/ tree in AGENTS.md, missing supply-chain field in README' --base main --head docs/fix-documentation-drift-2446e07b17baa2f4 --repo githubnext/ado-aw

Generated by Documentation Freshness Check · 2K AIC · ⌖ 27.7 AIC · ⊞ 36.5K ·

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