Skip to content

docs: fix documentation drift — add missing audit/ module to architecture tree #839

@github-actions

Description

@github-actions

Documentation Freshness Audit

This audit compared docs against the actual codebase across all documented areas: architecture tree, CLI commands, front matter fields, template markers, safe output tools, README, and prompts/create-ado-agentic-workflow.md.

Findings

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

Details

The src/audit/ directory contains the full implementation of the ado-aw audit command (18 Rust source files across analyzers/ and render/ sub-modules). While the command is correctly referenced in the CLI docs index (docs/cli.md) and the docs index in AGENTS.md, the architecture tree (the src/ directory listing) never included the module. This means AI agents reading the architecture section had no visibility into the audit module's structure, making it harder to navigate or extend.

All other checked areas were accurate:

  • CLI commands in docs/cli.md and README.md match src/main.rs
  • Front matter fields in docs/front-matter.md match src/compile/types.rs
  • Template markers in docs/template-markers.md match the src/data/*.yml templates
  • Safe output tools match src/safeoutputs/
  • Model table in prompts/create-ado-agentic-workflow.md matches src/engine.rs defaults

Applied Fixes

  • Added the complete src/audit/ module tree to the architecture section in AGENTS.md, with descriptions for all 18 source files

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

# Create a new branch
git checkout -b docs/fix-audit-module-architecture-660a66890d6e3963 main

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

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

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