Skip to content

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

@github-actions

Description

@github-actions

Documentation Freshness Audit

This audit found the following inconsistency between code and documentation:

Findings

Area Issue File(s)
Architecture section src/audit/ module (12 source files across 3 subdirectories) was entirely absent from the directory tree AGENTS.md

Details

The src/audit/ module implements the ado-aw audit CLI command and is a substantial, self-contained part of the codebase. It contains:

  • src/audit/mod.rs + cli.rs + cache.rs + findings.rs + model.rs + url.rs — top-level orchestration, argument types, caching, finding types, the AuditData report shape, and URL/build-id parsing
  • src/audit/analyzers/ — 8 files covering detection, firewall, jobs, MCP, missing-artifact, OTel, policy, and safe-output analyzers
  • src/audit/render/ — console and JSON renderers

Despite docs/audit.md and the CLI docs referencing this command, the architecture tree in AGENTS.md jumped directly from src/ado/discovery.rs to src/detect.rs, skipping the entire audit/ module. This means AI agents reading AGENTS.md to understand the codebase would have no visibility into the audit/ module's existence or structure.

Applied Fixes

  • Added the full src/audit/ subtree (including analyzers/ and render/ subdirectories with per-file descriptions) to the architecture section of AGENTS.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

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

# Create a new branch
git checkout -b docs/audit-module-architecture-tree-d7d61c90ab61dcb2 main

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

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

Generated by Documentation Freshness Check · sonnet46 2.5M ·

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