Skip to content

docs: fix documentation drift — audit module tree and export-gate-schema command #834

@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 src/audit/ subdirectory (18 files across analyzers/ and render/ sub-modules) was entirely absent from the architecture tree AGENTS.md
CLI commands export-gate-schema command was missing from the CLI command summary lists AGENTS.md, README.md

Details

1. Missing src/audit/ subtree in AGENTS.md

The actual source tree includes a full src/audit/ directory:

src/audit/
├── mod.rs, cli.rs, model.rs, cache.rs, findings.rs, url.rs
├── analyzers/  (detection, firewall, jobs, mcp, missing, otel, policy, safe_outputs)
└── render/     (console, json)

The AGENTS.md architecture tree had no entry for this module at all — audit only appeared in the documentation index bullet for docs/audit.md. Added the full subtree, positioned consistently with the other lifecycle command modules.

2. export-gate-schema missing from CLI summaries

src/main.rs defines and dispatches Commands::ExportGateSchemaexport-gate-schema CLI command. The command was already documented in docs/cli.md (lines 134–136), but the summary command lists in AGENTS.md and README.md did not include it.

Applied Fixes

  • Added full src/audit/ subtree to AGENTS.md architecture tree
  • Added export-gate-schema to the CLI command list in AGENTS.md
  • Added export-gate-schema to the CLI commands block 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 26838060715 -n agent -D /tmp/agent-26838060715

# Create a new branch
git checkout -b docs/fix-documentation-drift-audit-module-export-gate-schema-8b635d2ce5709123 main

# Apply the patch (--3way handles cross-repo patches)
git am --3way /tmp/agent-26838060715/aw-docs-fix-documentation-drift-audit-module-export-gate-schema.patch

# Push the branch and create the pull request
git push origin docs/fix-documentation-drift-audit-module-export-gate-schema-8b635d2ce5709123
gh pr create --title 'docs: fix documentation drift — audit module tree and export-gate-schema command' --base main --head docs/fix-documentation-drift-audit-module-export-gate-schema-8b635d2ce5709123 --repo githubnext/ado-aw

Generated by Documentation Freshness Check · sonnet46 2.3M ·

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