Skip to content

[docs] Self-healing documentation fixes from issue analysis - 2026-03-27#23240

Draft
github-actions[bot] wants to merge 1 commit intomainfrom
doc-healer/audit-subcommands-2026-03-27-4a48bc43743425fb
Draft

[docs] Self-healing documentation fixes from issue analysis - 2026-03-27#23240
github-actions[bot] wants to merge 1 commit intomainfrom
doc-healer/audit-subcommands-2026-03-27-4a48bc43743425fb

Conversation

@github-actions
Copy link
Contributor

Self-Healing Documentation Fixes

This PR was automatically created by the Daily Documentation Healer workflow.

Gaps Fixed

  • gh aw audit diff — not documented in cli.md. This subcommand compares behavioral drift between two workflow runs (new/removed domains, MCP tool changes, metrics).
  • gh aw audit report — not documented in cli.md. Added in feat: gh aw audit report — cross-run security audit reports #23047 (merged 2026-03-26), this subcommand generates cross-run security audit reports by aggregating firewall data across multiple runs.

The audit section was restructured from a flat command into h5 subsections (audit <run-id>, audit diff, audit report) following the same pattern used by the secrets command.

Root Cause

audit report was merged at 23:06 UTC on 2026-03-26 (#23047), after DDUw's daily 6am UTC run. DDUw therefore had no opportunity to document it before this healer run. audit diff predated the 7-day window but was never documented.

The systemic pattern: late-day merges (after DDUw's 6am window) are not picked up until the next daily run. If the doc-healer runs before DDUw the next day, it can catch these gaps.

💡 DDUw Improvement Suggestions

DDUw Improvement Suggestions

Pattern: Features merged after DDUw's 6am UTC run create a ~24-hour documentation lag. The doc-healer can bridge this gap but only if it runs after the merge and before the next DDUw run.

Suggested fix: DDUw could optionally run a second lightweight scan at ~22:00 UTC to catch late-day merges, or the doc-healer could be scheduled closer to midnight UTC so it catches same-day late merges before they become stale.

Second pattern: The audit command has subcommands (diff, report) but the docs treated it as a single command. DDUw's commit-scanning heuristic should flag new cmd.AddCommand(...) calls in audit.go as triggering a documentation review of the parent command's section.

Related Issues

Closed issues analyzed:

References:

Generated by Daily Documentation Healer ·

  • expires on Mar 30, 2026, 1:32 PM UTC

Add documentation for the two audit subcommands that were missing from
cli.md: audit diff (cross-run behavioral comparison) and audit report
(cross-run security audit). Also restructure the audit section to use
h5 subsections consistent with the secrets command pattern.

Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>
@github-actions github-actions bot added automation documentation Improvements or additions to documentation labels Mar 27, 2026
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

automation documentation Improvements or additions to documentation

Projects

None yet

Development

Successfully merging this pull request may close these issues.

0 participants