Skip to content

docs(site): add ado-aw audit reference page#826

Merged
jamesadevine merged 1 commit into
mainfrom
docs/site-audit-reference-57ee1a7ea2623799
Jun 2, 2026
Merged

docs(site): add ado-aw audit reference page#826
jamesadevine merged 1 commit into
mainfrom
docs/site-audit-reference-57ee1a7ea2623799

Conversation

@github-actions
Copy link
Copy Markdown
Contributor

@github-actions github-actions Bot commented Jun 2, 2026

Summary

  • Adds a full ado-aw audit reference page to the site, covering all accepted input formats, flags, output layout, report shape, cache behavior, and permission failure handling.
  • Adds a ### audit entry to the CLI Commands page with a cross-reference to the new reference page.
  • Adds "Audit" to the Reference sidebar in astro.config.mjs.

The audit command was added in #691 but was completely absent from the site. Users looking for how to audit a completed pipeline run had no site documentation to reference.

Changes

  • site/src/content/docs/reference/audit.mdx: new reference page ported and expanded from docs/audit.md
  • site/src/content/docs/setup/cli.mdx: added ### audit subsection with flag summary and link to the reference page
  • site/astro.config.mjs: added { label: 'Audit', slug: 'reference/audit' } to the Reference sidebar

Accuracy checks

  • All flags, defaults, and behaviors verified against docs/audit.md (canonical source of truth for the command).
  • AuditData key table verified against docs/audit.md — no invented keys.
  • Output layout verified against docs/audit.md layout section.

Validation

  • cd site && npm ci && npm run build
  • Build succeeded: 33 page(s) built (up from 32)
  • Starlight links validator: "All internal links are valid."

Created by the docs-writer workflow.

Generated by Docs Writer · sonnet46 1.6M ·

Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>
@jamesadevine jamesadevine marked this pull request as ready for review June 2, 2026 05:16
@jamesadevine jamesadevine merged commit 37f4160 into main Jun 2, 2026
@jamesadevine jamesadevine deleted the docs/site-audit-reference-57ee1a7ea2623799 branch June 2, 2026 05:16
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant