Skip to content

[Daily Report] Documentation Quality Report β€” April 18, 2026Β #26999

@github-actions

Description

@github-actions

Daily status report on documentation quality for the gh-aw project, cross-referenced against open issues.


πŸ†• What Changed Since April 15


πŸ› Open Documentation Issues

1. #16498 β€” Provider-based authentication for Claude, Copilot, Codex (open since Feb 2026)

Labels: documentation, enhancement, security

CLAUDE_CODE_OAUTH_TOKEN is documented as unsupported in reference/auth.mdx (line 121-123) β€” that part is correct and complete. However, the issue also flags a need for documentation of COPILOT_PROVIDER_* BYOK (Bring Your Own Key) variables introduced in Copilot CLI ~1.0.19.

Verified: Zero occurrences of COPILOT_PROVIDER in all docs.

Relevant docs: reference/auth.mdx, reference/engines.md
Status: ❌ Active gap β€” COPILOT_PROVIDER_* BYOK vars for Copilot engine remain undocumented. Open ~2 months.


2. #20391 β€” "Meet the Workflows" stale version links (open since March 2026)

Labels: documentation, automation, workflows

Blog posts contain 58 occurrences of version-pinned install links at v0.45.5. The latest release is v0.68.3. Example:

gh aw add-wizard https://github.com/github/gh-aw/blob/v0.45.5/.github/workflows/daily-doc-updater.md

Affected blog files (sample): 2026-01-13-meet-the-workflows-testing-validation.md, ...-metrics-analytics.md, ...-continuous-improvement.md, ...-quality-hygiene.md, and more.

Status: ❌ Ongoing β€” 58 stale v0.45.5 links across ~18 blog posts; latest release is v0.68.3. No link-update automation exists.


3. #25383 β€” Add Playwright smoke test for editor playground in docs CI (open since April 8)

Labels: enhancement

The /editor/ playground broke silently due to CDN version drift. No Playwright test covers the editor, and no tests run in CI (docs.yml builds but never runs npm run test).

This is a testing infrastructure gap rather than a content documentation gap. The proposal includes a new spec docs/tests/editor-playground.spec.ts and wiring Playwright into the CI job.

Relevant docs: No documentation to fix β€” this needs a new test file and CI step.
Status: ❌ Open β€” no editor smoke test, no Playwright in docs CI. Risk of silent regression.


βœ… Issues Where Documentation Already Has the Answer

#18821 β€” Review settings for repos with long build times (open since Feb 2026)

Labels: scout

The issue asks for documentation on timeout configuration for C++ / long-build repos. reference/sandbox.md already addresses this thoroughly:

  • Documents timeout-minutes frontmatter field (default: 20 min, can increase to 60–120)
  • Provides a table mapping repo type β†’ typical build time β†’ suggested timeout
  • Documents per-tool-call tools.timeout override (e.g., 300s for builds)
  • Includes C++ examples

Recommendation: This issue can be closed with a pointer to reference/sandbox.md#long-build-timeout-tuning.


πŸ†• New Issue With Documentation Implications

#26992 β€” CLI bridge type coercion bugs (filed today, Apr 18)

Labels: automation, testing, cli-tools

Four bugs in the agenticworkflows MCP CLI bridge were discovered during daily exploratory testing:

Bug Severity Docs impact
logs --count N fails (integer passed as string) High reference/gh-aw-as-mcp-server.md documents count as integer; no known workaround documented
compile --workflows "name" fails (array passed as string) High No CLI usage caveat documented
audit error responses have isError: false Medium MCP spec conformance β€” no docs
logs cache directory not accessible Medium Workaround exists: use /tmp/gh-aw/aw-mcp/logs/ directly

Documentation gap: reference/gh-aw-as-mcp-server.md should note the known workaround for the cache path (/tmp/gh-aw/aw-mcp/logs/), and flag the --count/--workflows CLI bridge bugs until they are fixed.

Status: πŸ†• Just filed β€” underlying bugs need fixing; interim doc workarounds would help users.


πŸ“Š Summary Table

Issue Type Docs Exist? Action Needed
#16498 BYOK auth for Copilot Missing content ❌ Partial Add COPILOT_PROVIDER_* to reference/auth.mdx
#20391 Stale v0.45.5 links Stale links ❌ Stale (58 links) Update or automate version links in blog
#25383 Editor playground CI Testing gap βž– N/A Add Playwright test + wire CI
#18821 Long build timeout βœ… Documented βœ… reference/sandbox.md Close issue with pointer to docs
#26992 CLI bridge type bugs Bug w/ doc gap ❌ No workaround Add interim workaround note to MCP server docs

Report generated 2026-04-18 Β· workflow run

Note

πŸ”’ Integrity filter blocked 40 items

The following items were blocked because they don't meet the GitHub integrity level.

  • #20593 search_issues: has lower integrity than agent requires. The agent cannot read data with integrity below "approved".
  • #25993 search_issues: has lower integrity than agent requires. The agent cannot read data with integrity below "approved".
  • #26069 search_issues: has lower integrity than agent requires. The agent cannot read data with integrity below "approved".
  • #18204 search_issues: has lower integrity than agent requires. The agent cannot read data with integrity below "approved".
  • #22161 search_issues: has lower integrity than agent requires. The agent cannot read data with integrity below "approved".
  • #18371 search_issues: has lower integrity than agent requires. The agent cannot read data with integrity below "approved".
  • #18372 search_issues: has lower integrity than agent requires. The agent cannot read data with integrity below "approved".
  • #24403 search_issues: has lower integrity than agent requires. The agent cannot read data with integrity below "approved".
  • #24961 search_issues: has lower integrity than agent requires. The agent cannot read data with integrity below "approved".
  • #26268 search_issues: has lower integrity than agent requires. The agent cannot read data with integrity below "approved".
  • #22533 search_issues: has lower integrity than agent requires. The agent cannot read data with integrity below "approved".
  • #17383 search_issues: has lower integrity than agent requires. The agent cannot read data with integrity below "approved".
  • #22430 search_issues: has lower integrity than agent requires. The agent cannot read data with integrity below "approved".
  • #19380 search_issues: has lower integrity than agent requires. The agent cannot read data with integrity below "approved".
  • #24422 search_issues: has lower integrity than agent requires. The agent cannot read data with integrity below "approved".
  • #24199 search_issues: has lower integrity than agent requires. The agent cannot read data with integrity below "approved".
  • ... and 24 more items

To allow these resources, lower min-integrity in your GitHub frontmatter:

tools:
  github:
    min-integrity: approved  # merged | approved | unapproved | none

Generated by Dev Β· ● 1.3M Β· β—·

  • expires on Apr 25, 2026, 9:06 AM UTC

Metadata

Metadata

Assignees

No one assigned

    Labels

    documentationImprovements or additions to documentation

    Type

    No type
    No fields configured for issues without a type.

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions