Skip to content

docs: fix documentation drift — add src/audit/ to AGENTS.md architecture tree #825

@github-actions

Description

@github-actions

Documentation Freshness Audit

This audit found the following inconsistency between code and documentation:

Findings

Area Issue File(s)
Architecture tree src/audit/ directory entirely absent from the architecture tree AGENTS.md

Details

The src/audit/ module implements the ado-aw audit command and is a substantial part of the codebase, with two sub-directories (analyzers/ and render/) and 18 source files. Despite being referenced in the docs index (docs/audit.md) and in the CLI documentation (docs/cli.md), the module was never added to the architecture tree in AGENTS.md.

This means agents reading AGENTS.md to understand the project structure would have an incomplete picture of where the audit implementation lives.

Applied Fixes

  • Added src/audit/ and all its sub-modules to the AGENTS.md architecture tree with one-line descriptions for each file

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

# Create a new branch
git checkout -b docs/audit-architecture-tree-37c83bff6f54fdf2 main

# Apply the patch (--3way handles cross-repo patches)
git am --3way /tmp/agent-26792738934/aw-docs-audit-architecture-tree.patch

# Push the branch and create the pull request
git push origin docs/audit-architecture-tree-37c83bff6f54fdf2
gh pr create --title 'docs: fix documentation drift — add src/audit/ to AGENTS.md architecture tree' --base main --head docs/audit-architecture-tree-37c83bff6f54fdf2 --repo githubnext/ado-aw

Generated by Documentation Freshness Check · sonnet46 2.9M ·

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