Skip to content

docs(site): add ado-aw-debug reference page#749

Merged
jamesadevine merged 1 commit into
mainfrom
docs-site-add-ado-aw-debug-reference-19d0b4691bf7bccf
May 25, 2026
Merged

docs(site): add ado-aw-debug reference page#749
jamesadevine merged 1 commit into
mainfrom
docs-site-add-ado-aw-debug-reference-19d0b4691bf7bccf

Conversation

@github-actions

Copy link
Copy Markdown
Contributor

Summary

  • Site users now have complete documentation for the ado-aw-debug: front-matter section, which was previously only documented in docs/ado-aw-debug.md.
  • The new reference page covers the debug-only create-issue safe output (three-layer gating, PAT setup, security checklist, auto-footer) and the skip-integrity flag.
  • Positioned logically after Safe Outputs in the Reference section sidebar.

Changes

  • site/src/content/docs/reference/ado-aw-debug.mdx — new reference page porting the complete content from docs/ado-aw-debug.md with proper MDX formatting:
    • Overview of the ado-aw-debug: section with danger callout emphasizing dogfood-only usage
    • Complete create-issue documentation: three-layer gating model, front-matter schema, agent parameters, PAT setup, auto-footer format, security checklist
    • skip-integrity flag documentation with rationale
    • Cross-references to Safe Outputs, CLI Commands, and Template Markers
  • site/astro.config.mjs — added { label: 'ado-aw-debug', slug: 'reference/ado-aw-debug' } to the Reference section sidebar, positioned after Safe Outputs

Accuracy checks

  • Source content verified against docs/ado-aw-debug.md (complete port)
  • create-issue tool implementation confirmed in src/safeoutputs/create_issue.rs:
    • Three-layer gating (MCP layer via DEBUG_ONLY_TOOLS, compiler layer via ado-aw-debug.create-issue:, executor layer via debug_enabled_tools set)
    • target-repo required, title-prefix, labels, allowed-labels (default-deny), assignees, max optional
    • Agent parameters: title, body, labels (optional), assignees (optional)
    • PAT via ADO_AW_DEBUG_GITHUB_TOKEN pipeline variable
    • Auto-footer with <!-- ado-aw --> marker
  • skip-integrity flag verified in compiler and template marker behavior
  • All internal links use correct site-relative paths (/ado-aw/reference/...)

Validation

  • cd site && npm ci && npm run build — 30 pages built (up from 29), all internal links valid

Created by the docs-writer workflow.

Generated by Docs Writer · ● 1.6M ·

Port the complete ado-aw-debug documentation from docs/ado-aw-debug.md to
the site as a reference page. This makes the debug-only front-matter
section visible to site users:

- create-issue safe output (three-layer gating, PAT setup, auto-footer)
- skip-integrity flag (bypasses integrity verification step)

Placed after Safe Outputs in the Reference section sidebar for logical
grouping (debug tools follow regular safe outputs).

Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>
@github-actions github-actions Bot mentioned this pull request May 25, 2026
@jamesadevine
jamesadevine marked this pull request as ready for review May 25, 2026 17:46
@jamesadevine
jamesadevine merged commit bddb860 into main May 25, 2026
@jamesadevine
jamesadevine deleted the docs-site-add-ado-aw-debug-reference-19d0b4691bf7bccf branch May 25, 2026 17:46
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