Skip to content

[Daily Report] Documentation Quality Report β€” April 20, 2026Β #27297

@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 19


πŸ› Open Documentation Issues

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

Labels: documentation, enhancement, security, cli

Copilot CLI 1.0.32 (tracked in #27143) ships the full COPILOT_PROVIDER_* BYOK variable set, but zero occurrences of COPILOT_PROVIDER exist anywhere in docs/. These variables are live and users need them:

Variable Purpose
COPILOT_PROVIDER_BASE_URL Custom model provider API endpoint
COPILOT_PROVIDER_TYPE Provider type: openai / azure / anthropic
COPILOT_PROVIDER_API_KEY API key for custom provider
COPILOT_PROVIDER_BEARER_TOKEN Bearer token
COPILOT_PROVIDER_WIRE_API API format: completions / responses
COPILOT_PROVIDER_MODEL_ID Well-known model ID
COPILOT_PROVIDER_MAX_PROMPT_TOKENS / _MAX_OUTPUT_TOKENS Token limits

Relevant docs: reference/auth.mdx, reference/engines.md, reference/environment-variables.md
Status: ❌ Critical gap β€” BYOK fully shipped but completely undocumented. Open ~2 months.


2. #20391 β€” Blog posts point to stale v0.45.5 install links (open since March 2026)

Labels: documentation, automation, workflows

115 occurrences of v0.45.5 across ~18 "Meet the Workflows" blog posts. 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

No automated version-link update mechanism exists.

Status: ❌ Ongoing β€” 115 stale links, gap open 6+ weeks.


3. #27143 β€” Copilot CLI 1.0.32 new features undocumented (filed Apr 19)

Labels: automation, dependencies

Beyond the BYOK vars tracked in #16498, several new CLI 1.0.32 features have no docs coverage:

  • --add-github-mcp-tool / --add-github-mcp-toolset β€” granular GitHub MCP server tool control; relevant to reference/tools.md
  • hooks config key β€” inline hook definitions by event; new concept with no docs
  • COPILOT_OFFLINE env var β€” offline mode; may need mention in sandbox docs
  • 13 new model catalog entries (claude-opus-4.6/4.7, gpt-5.x series) β€” reference/engines.md model list potentially stale

Status: ❌ Documentation review needed for 1.0.32 feature set.


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

Labels: enhancement

The /editor/ playground broke silently before due to CDN version drift. Docs CI builds but never runs npm run test. Risk of silent regression remains.

Relevant docs: Testing infrastructure only β€” no content to fix.
Status: ❌ Open β€” no editor smoke test wired into docs CI.


πŸ†• New Issue With Documentation Implications

#27265 β€” close-issue schema rejects documented state-reason field (filed Apr 20)

Labels: bug, workflows, compiler

The documentation shows state-reason as a valid close-issue frontmatter field, but the JSON schema at pkg/parser/schemas/main_workflow_schema.json omits it, so gh aw compile rejects it with:

error: Unknown property: state-reason. Valid fields are: allowed-repos, max, required-labels, ...

The Go struct (CloseEntityConfig.StateReason) and handler emission are correct β€” only the schema is missing the field.

Relevant docs: reference/safe-outputs-*.md (documents state-reason as valid)
Status: πŸ†• Doc/schema mismatch β€” schema needs state-reason property added; schema rebuild required after fix.


βœ… Issues Where Documentation Already Has the Answer

#22001 β€” Add WorkQueueOps and BatchOps doc pages (open since March 20)

Labels: documentation

Both pages were created April 18 (commit f7e3992) and are now live:

Recommendation: This issue can be closed with a pointer to the new pattern pages.


πŸ“Š Summary Table

Issue Type Docs Exist? Action Needed
#16498 BYOK auth for Copilot Missing content ❌ None Add COPILOT_PROVIDER_* to reference/auth.mdx + engines.md
#20391 Stale v0.45.5 blog links Stale links ❌ Stale (115 links) Automate version link updates in blog
#22001 WorkQueueOps/BatchOps pages βœ… Added Apr 18 βœ… Patterns pages live Close issue with pointer to docs
#25383 Editor playground CI Testing gap βž– N/A Add Playwright test + wire docs CI
#27143 CLI 1.0.32 new features New features ❌ Partial Document hooks, MCP tool flags, models, offline mode
#27265 close-issue state-reason Schema mismatch βœ… Docs correct Fix JSON schema + rebuild binary

Report generated 2026-04-20 Β· workflow run

Note

πŸ”’ Integrity filter blocked 12 items

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

  • #27260 search_issues: has lower integrity than agent requires. The agent cannot read data with integrity below "approved".
  • #27259 search_issues: has lower integrity than agent requires. The agent cannot read data with integrity below "approved".
  • #27250 search_issues: has lower integrity than agent requires. The agent cannot read data with integrity below "approved".
  • #26175 search_issues: has lower integrity than agent requires. The agent cannot read data with integrity below "approved".
  • #26719 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".
  • #18992 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".
  • #21813 search_issues: has lower integrity than agent requires. The agent cannot read data with integrity below "approved".
  • #21242 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".
  • #27282 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 Β· ● 857.8K Β· β—·

  • expires on Apr 27, 2026, 9:28 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