Skip to content

docs: fix architecture drift in AGENTS.md #1089

@github-actions

Description

@github-actions

Documentation Freshness Audit

This audit found the following inconsistencies between code and documentation:

Findings

Area Issue File(s)
Architecture tree compile/ir/ directory listed twice with different content AGENTS.md
Architecture tree summary.rs missing from the canonical compile/ir/ listing AGENTS.md
Documentation Index CLI commands summary missing mcp-author, trace, inspect, graph, whatif, lint, catalog AGENTS.md

Details

1. Duplicate compile/ir/ directory listing

The src/compile/ir/ subdirectory appeared twice in the AGENTS.md architecture tree:

  • First listing (line ~54): included tasks.rs but was missing summary.rs — this was the original listing, predating the addition of summary.rs.
  • Second listing (line ~105): appeared after codemod_integration_test.rs and types.rs using a └── connector, as if it were the last item in compile/. It included summary.rs but was missing tasks.rs — this was added when summary.rs was introduced, but the first listing was never updated or removed.

The actual directory (src/compile/ir/) contains both tasks.rs and summary.rs.

2. CLI commands missing from Documentation Index

The docs/cli.md entry in the Documentation Index only listed 13 commands, omitting 7 commands that are fully documented in docs/cli.md itself:

Missing: mcp-author, trace, inspect, graph, whatif, lint, catalog

Applied Fixes

  • Remove duplicate compile/ir/ listing (the second, misplaced one)
  • Add summary.rs to the canonical compile/ir/ listing (the first, correctly-placed one)
  • Fix compile/types.rs tree connector from ├── to └── (it is now the last item in compile/ after removing the duplicate ir/ block)
  • Add missing CLI commands to the docs/cli.md index description: mcp-author, trace, inspect, graph, whatif, lint, catalog

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

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 27751566405 -n agent -D /tmp/agent-27751566405

# Create a new branch
git checkout -b docs/fix-architecture-drift-1781777100-db1cb2d83b9d0606 main

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

# Push the branch and create the pull request
git push origin docs/fix-architecture-drift-1781777100-db1cb2d83b9d0606
gh pr create --title 'docs: fix architecture drift in AGENTS.md' --base main --head docs/fix-architecture-drift-1781777100-db1cb2d83b9d0606 --repo githubnext/ado-aw

Generated by Documentation Freshness Check · 1.6K AIC · ⌖ 28 AIC · ⊞ 35K ·

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