Repository navigation
[docs] docs: unbloat reference/audit.md - #70991
Merged
Merged
Conversation
github-actions
Bot
added
automation
doc-unbloat
documentation
pelikhan
marked this pull request as ready for review
October 22, 2026 02:08
Contributor
Author
|
🔬 Test Quality Sentinel is analyzing test quality on this pull request... |
Contributor
There was a problem hiding this comment.
🟡 Changes recommended
Some edits lose or obscure technical guidance that the documentation cleanup is intended to preserve.
2 open issues
What changed in this PR
This documentation-only PR shortens gh-aw’s auditing reference for single-run analysis and cross-run reports.
Changes:
- Consolidates argument descriptions and overlapping flag explanations.
- Removes redundant command examples.
- Tightens token-usage, JSON-schema, and reporting descriptions.
| File | Description |
|---|---|
docs/src/content/docs/reference/audit.md |
Condenses audit and logs command guidance and examples. |
Review effort: Max
| safe-output diagnostics also print the relevant playbook URL. | ||
|
|
||
| The Metrics section includes an `ambient_context` object when available. Ambient context captures the first LLM inference footprint for the run. It is absent when token-usage data is unavailable for the run — for example, when neither `token-usage.jsonl` nor the fallback `agent_usage.json` can be found in the downloaded artifacts, which is common for older runs and runs without firewall/usage artifacts: | ||
| The Metrics section includes an `ambient_context` object capturing the first LLM inference footprint. It is absent when neither `token-usage.jsonl` nor the fallback `agent_usage.json` is in the downloaded artifacts (common for older runs and runs without firewall/usage artifacts): |
|
|
||
| Top-level fields in `--json` output are stable; nested sub-fields may be extended but are not removed without deprecation. | ||
|
|
||
| The report output includes an executive summary, domain inventory, metrics trends, MCP server health, and per-run breakdown. It detects cross-run anomalies such as domain access spikes, elevated MCP error rates, and connection rate changes. |
Contributor
Author
|
🎉 This pull request is included in a new release. Release: |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Unbloat:
docs/src/content/docs/reference/audit.mdCondensed redundant prose and examples while keeping all technical details:
--stdin,--no-baseline, andambient_contextexplanationsReduction: about 280 words (~4003 → ~3727), 40 lines removed. No code blocks, tables of codes, or links dropped.