Skip to content

docs: add audit/ module to AGENTS.md architecture tree #829

@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/ module directory missing from architecture tree AGENTS.md

Details

The src/audit/ module — which implements the ado-aw audit CLI command — was added to the codebase but never reflected in the architecture tree in AGENTS.md. The module contains 18 source files across three layers:

  • src/audit/ — top-level: mod.rs, cli.rs, model.rs, findings.rs, cache.rs, url.rs
  • src/audit/analyzers/ — individual analyzers: detection.rs, firewall.rs, jobs.rs, mcp.rs, missing.rs, otel.rs, policy.rs, safe_outputs.rs
  • src/audit/render/ — report renderers: console.rs, json.rs

The audit command was already referenced in the AGENTS.md CLI index (docs/audit.md link) and in docs/cli.md, but the architecture source tree had no entry for src/audit/. This is the only drift found — all other documentation areas (CLI commands, FrontMatter fields, template markers, safe-output tools, engine defaults, prompts) are accurate.

Applied Fixes

  • Added src/audit/ directory with all sub-modules and files to the architecture tree in 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 26812118100 -n agent -D /tmp/agent-26812118100

# Create a new branch
git checkout -b docs/audit-architecture-tree-97881213cb901b66 main

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

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

Generated by Documentation Freshness Check · sonnet46 1.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