Skip to content

[Daily Report] Documentation Quality Report β€” April 14, 2026Β #26174

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


πŸ› 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 used in workflow code but undocumented. Copilot CLI 1.0.19 introduced BYOK (COPILOT_PROVIDER_BASE_URL, COPILOT_PROVIDER_TYPE, COPILOT_PROVIDER_API_KEY) β€” none of these appear anywhere in the docs.

Verified gaps (zero matches in docs):

  • reference/auth.mdx β€” no COPILOT_PROVIDER_* entries, no BYOK section
  • reference/engines.md β€” no COPILOT_PROVIDER_* entries
  • reference/environment-variables.md β€” no COPILOT_PROVIDER_* entries

Status: ❌ Active gap β€” BYOK and provider-based auth entirely undocumented. Open ~2 months.


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

Labels: documentation, automation, workflows

All "Meet the Workflows" blog posts still reference v0.45.5 in install links. Confirmed: 115 occurrences of v0.45.5 across the blog directory.

gh aw add-wizard https://github.com/github/gh-aw/blob/v0.45.5/.github/workflows/...

Status: ❌ Ongoing β€” 115 stale version-pinned links across blog files, no automation covers them.


3. Copilot CLI 1.0.24 --mode / --plan flags (new since Apr 13 report)

Related: #25978 (closed not_planned without docs)

Copilot CLI 1.0.24 (shipped Apr 13) adds:

  • --mode <interactive|plan|autopilot> β€” set initial agent mode
  • --plan β€” shorthand for plan mode
  • Clarified --autopilot description

reference/engines.md documents --autopilot but has no mention of --mode or --plan. The version checker issue was closed without triggering documentation updates.

Relevant docs: reference/engines.md
Status: ❌ New gap β€” docs not updated for 1.0.24 release.


4. MCP Gateway v0.2.18 reaction endorsement (new β€” undocumented feature)

MCP Gateway v0.2.18 (shipped Apr 12) adds reaction-based integrity endorsement:

  • Thumbs-up/heart reactions from trusted members can promote content integrity
  • Thumbs-down/confused can demote content
  • endorsement-reactions and disapproval-reactions config keys

No documentation exists for this feature. The integrity reference page (reference/integrity.md) and frontmatter reference need updating.

Relevant docs: reference/integrity.md, reference/frontmatter.md
Status: ❌ New gap β€” new MCP Gateway feature with zero documentation.


5. #18821 β€” Settings for repositories with long build times (open since Feb 2026)

Labels: scout

Repos with 5–10 min build times (C++, large monorepos) can hit MCP/Bash tool timeouts. No documentation covers timeout configuration per agent or recommended settings.

Relevant docs: reference/sandbox.md, reference/engines.md
Gap: No dedicated timeout guidance section anywhere.
Status: ❌ Ongoing gap β€” open ~7 weeks, unassigned.


βœ… Issues Where Documentation Already Contains the Answer

#22001 β€” WorkQueueOps and BatchOps pages

Labels: documentation

Both pages already exist and are substantial:

  • patterns/workqueue-ops.md β€” 188 lines βœ…
  • patterns/batch-ops.md β€” 268 lines βœ…

This issue can be closed with pointers to the two pattern pages.


πŸ“Š Summary

Issue Title Status Relevant Doc
#16498 Copilot BYOK / provider-based auth undocumented ❌ Gap (2mo) reference/auth.mdx, reference/engines.md
#20391 "Meet the Workflows" stale v0.45.5 links (115 occurrences) ❌ Gap blog/ directory
#18821 Settings for long build times ❌ Gap (7wk) reference/sandbox.md
(no issue) Copilot CLI 1.0.24 --mode/--plan flags ❌ New gap reference/engines.md
(no issue) MCP Gateway v0.2.18 reaction endorsement ❌ New gap reference/integrity.md
#22001 WorkQueueOps and BatchOps pages βœ… Can close β€” docs exist

πŸ” Documentation Structure Health

148 documentation files across docs/src/content/docs/. Priority files needing attention:

  • reference/engines.md β€” Add Copilot 1.0.24 --mode/--plan flags
  • reference/auth.mdx β€” Add BYOK section (COPILOT_PROVIDER_* env vars), document CLAUDE_CODE_OAUTH_TOKEN
  • reference/integrity.md β€” Add MCP Gateway v0.2.18 reaction endorsement (endorsement-reactions, disapproval-reactions)
  • reference/sandbox.md β€” Add timeout configuration guidance for long-build repos
  • blog/ β€” 115 stale v0.45.5 version-pinned links need updating

🎯 Recommended Actions

  1. High priority: Document Copilot CLI 1.0.24 --mode/--plan in reference/engines.md β€” new release, quick update
  2. High priority: Document MCP Gateway v0.2.18 reaction endorsement in reference/integrity.md β€” new security-relevant feature
  3. Medium priority: Add BYOK documentation to reference/auth.mdx (Provider-based authentication for Claude, Copilot, Codex.Β #16498 β€” open 2 months)
  4. Low priority: Close Add WorkQueueOps and BatchOps doc pages under design patternsΒ #22001 β€” workqueue-ops and batch-ops pages already exist
  5. Low priority: Add timeout guidance to reference/sandbox.md (Review settings for using in repositories with long build timesΒ #18821)

Note

πŸ”’ Integrity filter blocked 22 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".
  • #26101 search_issues: has lower integrity than agent requires. The agent cannot read data with integrity below "approved".
  • #25363 search_issues: has lower integrity than agent requires. The agent cannot read data with integrity below "approved".
  • #19080 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".
  • #21426 search_issues: has lower integrity than agent requires. The agent cannot read data with integrity below "approved".
  • #24949 search_issues: has lower integrity than agent requires. The agent cannot read data with integrity below "approved".
  • #21615 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".
  • #24403 search_issues: has lower integrity than agent requires. The agent cannot read data with integrity below "approved".
  • #22897 search_issues: has lower integrity than agent requires. The agent cannot read data with integrity below "approved".
  • #26120 search_issues: has lower integrity than agent requires. The agent cannot read data with integrity below "approved".
  • #11190 search_issues: has lower integrity than agent requires. The agent cannot read data with integrity below "approved".
  • #18329 search_issues: has lower integrity than agent requires. The agent cannot read data with integrity below "approved".
  • ... and 6 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.4M Β· β—·

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