You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
π Documentation Quality Report β April 5, 2026
This report summarizes open issues related to documentation quality in the gh-aw project, cross-referenced against current documentation coverage.
π Open Documentation Issues
1. #16498 β Provider-based authentication for Claude, Copilot, Codex
Labels:documentation, enhancement, security
CLAUDE_CODE_OAUTH_TOKEN is referenced in workflow code but barely mentioned in docs. Provider-based authentication (OAuth, cloud-provider auth) for Claude, Codex, and Copilot engines is undocumented. Users have no guidance on how to configure it or whether secrets are needed.
Relevant docs:docs/src/content/docs/reference/auth.mdx, docs/src/content/docs/reference/engines.md Gap:auth.mdx only mentions API key method at platform.claude.com. No OAuth or provider-based auth coverage exists in either file. Status: β Documentation gap β no existing content covers this.
2. #20391 β "Meet the workflows" blog links pinned to specific versions
Labels:documentation, automation, workflows
"Meet the workflows" blog posts contain version-pinned gh aw add-wizard links (e.g., v0.45.5) that become stale as the repo evolves. These are logically internal links but treated as external, bypassing link validation.
Relevant docs:docs/src/content/docs/blog/2026-01-13-meet-the-workflows-*.md (multiple files) Gap: No automation exists to update version pins or validate these links. Docs contain stale versioned references. Status: β Documentation maintenance gap β stale version links present.
3. #22001 β Add WorkQueueOps and BatchOps design pattern pages
Labels:documentation
No documentation exists covering work queue and batching patterns β common use cases for agentic workflows. The issue outlines multiple approaches (issue checklists, sub-issues, cache/repo memory, discussions) and batch operation strategies.
Relevant docs:docs/src/content/docs/patterns/ directory (exists, contains daily-ops.md, issue-ops.md, etc.) Gap: No workqueue-ops.md or batch-ops.md pattern pages exist. Status: β Documentation gap β missing pattern pages.
4. #24681 β Add repo-memory stateful scanning example (plan, assigned to Copilot)
Labels:plan, ai-generated
No documented example of the "load baseline β scan β diff β write baseline" pattern for alert-on-new-X workflows using repo-memory. This pattern independently surfaced in 3 of 8 agent persona test scenarios.
Relevant docs:docs/src/content/docs/reference/repo-memory.md, .github/aw/memory.md Gap:repo-memory.md mentions visual regression baselines but contains no stateful scanning lifecycle example with flood prevention guidance. Status: β Documentation gap β pattern not documented. Plan issue is active and assigned.
No documented guidance on downloading heavy data (workflow logs, CI artifacts, build output) before the AI session begins. This pattern reduces token usage and improves reliability, yet no section covers it in create-agentic-workflow.md.
Relevant docs:.github/aw/create-agentic-workflow.md Gap: Pre-step data-fetching section is absent. No cross-reference to repo-memory for baseline loading. Status: β Documentation gap β pattern not documented. Plan issue is active and assigned.
β Issues Where Docs Already Contain the Answer
No open issues were found where existing documentation already fully resolves the question. All five identified issues represent genuine gaps.
Active plans (#24681, #24682) are already assigned to Copilot with clear acceptance criteria. The highest-impact remaining gap is #16498 (provider-based auth), which affects security-sensitive configuration with no current documentation at all.
Note
π Integrity filter blocked 28 items
The following items were blocked because they don't meet the GitHub integrity level.
#20593search_issues: has lower integrity than agent requires. The agent cannot read data with integrity below "approved".
#18204search_issues: has lower integrity than agent requires. The agent cannot read data with integrity below "approved".
#18372search_issues: has lower integrity than agent requires. The agent cannot read data with integrity below "approved".
#22161search_issues: has lower integrity than agent requires. The agent cannot read data with integrity below "approved".
#24403search_issues: has lower integrity than agent requires. The agent cannot read data with integrity below "approved".
#18371search_issues: has lower integrity than agent requires. The agent cannot read data with integrity below "approved".
#20717search_issues: has lower integrity than agent requires. The agent cannot read data with integrity below "approved".
#20514search_issues: has lower integrity than agent requires. The agent cannot read data with integrity below "approved".
#21306search_issues: has lower integrity than agent requires. The agent cannot read data with integrity below "approved".
#19611search_issues: has lower integrity than agent requires. The agent cannot read data with integrity below "approved".
#19080search_issues: has lower integrity than agent requires. The agent cannot read data with integrity below "approved".
#17352search_issues: has lower integrity than agent requires. The agent cannot read data with integrity below "approved".
#21436search_issues: has lower integrity than agent requires. The agent cannot read data with integrity below "approved".
#19703search_issues: has lower integrity than agent requires. The agent cannot read data with integrity below "approved".
#22585search_issues: has lower integrity than agent requires. The agent cannot read data with integrity below "approved".
#22533search_issues: has lower integrity than agent requires. The agent cannot read data with integrity below "approved".
... and 12 more items
To allow these resources, lower min-integrity in your GitHub frontmatter:
π Documentation Quality Report β April 5, 2026
This report summarizes open issues related to documentation quality in the gh-aw project, cross-referenced against current documentation coverage.
π Open Documentation Issues
1. #16498 β Provider-based authentication for Claude, Copilot, Codex
Labels:
documentation,enhancement,securityCLAUDE_CODE_OAUTH_TOKENis referenced in workflow code but barely mentioned in docs. Provider-based authentication (OAuth, cloud-provider auth) for Claude, Codex, and Copilot engines is undocumented. Users have no guidance on how to configure it or whether secrets are needed.Relevant docs:
docs/src/content/docs/reference/auth.mdx,docs/src/content/docs/reference/engines.mdGap:
auth.mdxonly mentions API key method atplatform.claude.com. No OAuth or provider-based auth coverage exists in either file.Status: β Documentation gap β no existing content covers this.
2. #20391 β "Meet the workflows" blog links pinned to specific versions
Labels:
documentation,automation,workflows"Meet the workflows" blog posts contain version-pinned
gh aw add-wizardlinks (e.g.,v0.45.5) that become stale as the repo evolves. These are logically internal links but treated as external, bypassing link validation.Relevant docs:
docs/src/content/docs/blog/2026-01-13-meet-the-workflows-*.md(multiple files)Gap: No automation exists to update version pins or validate these links. Docs contain stale versioned references.
Status: β Documentation maintenance gap β stale version links present.
3. #22001 β Add WorkQueueOps and BatchOps design pattern pages
Labels:
documentationNo documentation exists covering work queue and batching patterns β common use cases for agentic workflows. The issue outlines multiple approaches (issue checklists, sub-issues, cache/repo memory, discussions) and batch operation strategies.
Relevant docs:
docs/src/content/docs/patterns/directory (exists, containsdaily-ops.md,issue-ops.md, etc.)Gap: No
workqueue-ops.mdorbatch-ops.mdpattern pages exist.Status: β Documentation gap β missing pattern pages.
4. #24681 β Add repo-memory stateful scanning example (plan, assigned to Copilot)
Labels:
plan,ai-generatedNo documented example of the "load baseline β scan β diff β write baseline" pattern for alert-on-new-X workflows using
repo-memory. This pattern independently surfaced in 3 of 8 agent persona test scenarios.Relevant docs:
docs/src/content/docs/reference/repo-memory.md,.github/aw/memory.mdGap:
repo-memory.mdmentions visual regression baselines but contains no stateful scanning lifecycle example with flood prevention guidance.Status: β Documentation gap β pattern not documented. Plan issue is active and assigned.
5. #24682 β Document pre-step data-fetching pattern (plan, assigned to Copilot)
Labels:
plan,ai-generatedNo documented guidance on downloading heavy data (workflow logs, CI artifacts, build output) before the AI session begins. This pattern reduces token usage and improves reliability, yet no section covers it in
create-agentic-workflow.md.Relevant docs:
.github/aw/create-agentic-workflow.mdGap: Pre-step data-fetching section is absent. No cross-reference to repo-memory for baseline loading.
Status: β Documentation gap β pattern not documented. Plan issue is active and assigned.
β Issues Where Docs Already Contain the Answer
No open issues were found where existing documentation already fully resolves the question. All five identified issues represent genuine gaps.
π Summary
reference/auth.mdx,reference/engines.mdblog/2026-01-13-meet-the-workflows-*.mdpatterns/directoryreference/repo-memory.md.github/aw/create-agentic-workflow.mdActive plans (#24681, #24682) are already assigned to Copilot with clear acceptance criteria. The highest-impact remaining gap is #16498 (provider-based auth), which affects security-sensitive configuration with no current documentation at all.
Note
π Integrity filter blocked 28 items
The following items were blocked because they don't meet the GitHub integrity level.
search_issues: has lower integrity than agent requires. The agent cannot read data with integrity below "approved".search_issues: has lower integrity than agent requires. The agent cannot read data with integrity below "approved".search_issues: has lower integrity than agent requires. The agent cannot read data with integrity below "approved".search_issues: has lower integrity than agent requires. The agent cannot read data with integrity below "approved".search_issues: has lower integrity than agent requires. The agent cannot read data with integrity below "approved".search_issues: has lower integrity than agent requires. The agent cannot read data with integrity below "approved".search_issues: has lower integrity than agent requires. The agent cannot read data with integrity below "approved".search_issues: has lower integrity than agent requires. The agent cannot read data with integrity below "approved".search_issues: has lower integrity than agent requires. The agent cannot read data with integrity below "approved".search_issues: has lower integrity than agent requires. The agent cannot read data with integrity below "approved".search_issues: has lower integrity than agent requires. The agent cannot read data with integrity below "approved".search_issues: has lower integrity than agent requires. The agent cannot read data with integrity below "approved".search_issues: has lower integrity than agent requires. The agent cannot read data with integrity below "approved".search_issues: has lower integrity than agent requires. The agent cannot read data with integrity below "approved".search_issues: has lower integrity than agent requires. The agent cannot read data with integrity below "approved".search_issues: has lower integrity than agent requires. The agent cannot read data with integrity below "approved".To allow these resources, lower
min-integrityin your GitHub frontmatter: