Parent Epic
Part of #22735
Summary
Several existing documentation pages should be updated to reference the audit feature, improving discoverability for users who arrive via related topics.
Pages to Update
1. docs/src/content/docs/reference/glossary.md
Add glossary entries for:
- Audit — CLI command for analyzing workflow run behavior, security, and cost
- Audit diff — comparison of two workflow runs across firewall, MCP, and metrics dimensions
- Cross-run report — aggregated security and performance analysis across multiple runs
- Behavior fingerprint — multi-dimensional characterization of a workflow run
- Firewall analysis — breakdown of allowed/blocked network requests with policy attribution
2. docs/src/content/docs/patterns/monitoring.md
- Add a section or callout linking to audit commands as the primary monitoring tool for agentic workflows
- Reference
gh aw audit report for trend monitoring
3. docs/src/content/docs/reference/network.md
- Cross-reference audit's firewall analysis section for understanding domain allow/block behavior
- Mention
gh aw audit diff for comparing firewall behavior between runs
4. docs/src/content/docs/reference/mcp-gateway.md
- Reference audit's MCP Server Health and guard policy analysis sections
- Link to audit for debugging MCP failures
5. docs/src/content/docs/troubleshooting/debugging.md
- Expand existing audit mention to cover
audit diff and audit report as debugging tools
- Add cross-references to the new audit reference and guide pages
6. docs/src/content/docs/reference/cost-management.md
- Reference audit's cost/token metrics for tracking spend
- Mention
audit report for cost trend analysis across runs
Parent Epic
Part of #22735
Summary
Several existing documentation pages should be updated to reference the audit feature, improving discoverability for users who arrive via related topics.
Pages to Update
1.
docs/src/content/docs/reference/glossary.mdAdd glossary entries for:
2.
docs/src/content/docs/patterns/monitoring.mdgh aw audit reportfor trend monitoring3.
docs/src/content/docs/reference/network.mdgh aw audit difffor comparing firewall behavior between runs4.
docs/src/content/docs/reference/mcp-gateway.md5.
docs/src/content/docs/troubleshooting/debugging.mdaudit diffandaudit reportas debugging tools6.
docs/src/content/docs/reference/cost-management.mdaudit reportfor cost trend analysis across runs