Skip to content

[Daily Report] Documentation Quality Report — May 1, 2026 #29489

@github-actions

Description

@github-actions

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


Open Documentation Issues (2026-05-01)

Issues Labeled documentation

# Title Age Finding
#16498 Provider-based authentication for Claude, Copilot, Codex ~10 weeks ⚠️ Partially documented — see below
#20391 Meet-the-workflows blog posts link to pinned versions, need auto-update ~7 weeks ❌ No automation exists yet
#22001 Add WorkQueueOps and BatchOps doc pages under design patterns ~6 weeks ✅ Both pages now exist — may be closeable

Issue-by-Issue Analysis

#16498 — Provider-based authentication for Claude, Copilot, Codex

Problem reported: Two sub-issues: (1) CLAUDE_CODE_OAUTH_TOKEN is barely documented; (2) provider-based (cloud-billed) auth for Claude/Codex/Copilot is not supported but should be considered.

Current documentation state:

  • docs/src/content/docs/reference/auth.mdx (line 121–123) explicitly documents that CLAUDE_CODE_OAUTH_TOKEN is not supported and that ANTHROPIC_API_KEY must be used instead.
  • The troubleshooting section (line 199) also clarifies the confusion.

Assessment: The documentation gap around CLAUDE_CODE_OAUTH_TOKEN has been addressed. The underlying feature request (actually supporting provider-based auth) remains open. This issue could be partially closed with a pointer to auth.mdx, noting that the documentation clarification is done and only the enhancement work remains.


#20391 — Meet-the-workflows blog posts link to pinned versions

Problem reported: Blog posts like 2026-01-13-meet-the-workflows.md contain hardcoded v0.45.5 version links (e.g., gh aw add-wizard https://github.com/github/gh-aw/blob/v0.45.5/...). These will become stale as versions advance.

Current documentation state:

  • Confirmed present in docs/src/content/docs/blog/2026-01-13-meet-the-workflows.md.
  • No automation exists to keep these links current.
  • The issue also requests internal link validation for these "logically in-repo" external links.

Gap: No doc page covers how to install current workflow versions vs. pinned versions, and no CI link-validation covers version-pinned GitHub blob URLs.


#22001 — WorkQueueOps and BatchOps doc pages missing

Problem reported: No documentation for work-queue and batching patterns.

Current documentation state:

  • docs/src/content/docs/patterns/workqueue-ops.mdexists (WorkQueueOps page with queue-based badge)
  • docs/src/content/docs/patterns/batch-ops.mdexists (BatchOps page with batch-processing badge)

Assessment: ✅ Both pages have been created since this issue was filed. This issue can likely be closed.


Related Open Issues (Documentation-Adjacent)

# Title Type
#25381 Playground editor fails to load: duplicate @codemirror/state versions Bug in doc site tooling
#25383 Add Playwright smoke test for editor playground in docs CI CI gap for doc site

These two issues are related (filed same day by the same author): the playground editor is broken and there is no CI test to catch it. Neither is a content/prose documentation gap — they are infrastructure issues for the documentation site.


Summary

Category Count
✅ Documentation already addresses the issue (closeable) 1 (#22001)
⚠️ Partially addressed — feature still open but docs improved 1 (#16498)
❌ Gap — no automation / missing content 1 (#20391)
🔧 Doc site infrastructure bugs 2 (#25381, #25383)

Top Recommendations

  1. Close Add WorkQueueOps and BatchOps doc pages under design patterns #22001 — Both WorkQueueOps and BatchOps pages exist; the requested work is done.
  2. Add a comment to Provider-based authentication for Claude, Copilot, Codex. #16498 pointing to auth.mdx documenting CLAUDE_CODE_OAUTH_TOKEN unsupported; separate the remaining enhancement work.
  3. Meet the workflows points to specific versions, need to keep these up to date #20391 needs automation work: a script or workflow to update versioned links in blog posts and add link validation to CI.
  4. Playground editor fails to load: duplicate @codemirror/state versions from esm.sh #25381 + Add Playwright smoke test for editor playground in docs CI #25383: Fix the pinned CodeMirror version in docs/public/editor/editor.js and wire Playwright tests into docs.yml.

Note

🔒 Integrity filter blocked 9 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".
  • #27886 search_issues: has lower integrity than agent requires. The agent cannot read data with integrity below "approved".
  • #20997 search_issues: has lower integrity than agent requires. The agent cannot read data with integrity below "approved".
  • #29417 search_issues: has lower integrity than agent requires. The agent cannot read data with integrity below "approved".
  • #21130 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".
  • #22929 search_issues: has lower integrity than agent requires. The agent cannot read data with integrity below "approved".
  • #26598 search_issues: has lower integrity than agent requires. The agent cannot read data with integrity below "approved".
  • #20413 search_issues: has lower integrity than agent requires. The agent cannot read data with integrity below "approved".

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

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

Generated by Dev · ● 1.1M ·

  • expires on May 8, 2026, 9:22 AM UTC

Metadata

Metadata

Assignees

No one assigned

    Labels

    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