Skip to content

[Daily Report] Documentation Quality Report β€” April 16, 2026Β #26592

@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

The issue asks for documentation (and support) of provider-based authentication across engines.

Current doc state:

Relevant docs: reference/auth.mdx, reference/frontmatter.md, reference/engines.md
Status: ❌ Partially addressed β€” BYOK model requirement undocumented, now also a live bug.


2. #20391 β€” Stale version-pinned links in blog posts (open since Mar 2026)

Labels: documentation, automation, workflows

Blog posts contain gh aw add-wizard links pinned to v0.45.5 β€” an old release. No automation keeps these current.

Current doc state:

  • 115 occurrences of v0.45.5 across docs/src/content/docs/blog/ βœ… confirmed
  • No link validation automation in place

Relevant docs: docs/src/content/docs/blog/ (18+ files)
Status: ❌ Ongoing β€” 115 stale version-pinned links, unresolved for 5+ weeks.


3. #26565 β€” byok-copilot empty COPILOT_MODEL fallback (NEW, Apr 16)

Labels: bug

Copilot CLI 1.0.28 in BYOK mode requires an explicit model (COPILOT_MODEL). The compiler currently generates an empty string fallback, causing immediate failure. The workaround (manually patching .lock.yml) is tedious and breaks on every recompile.

Current doc state:

  • reference/glossary.md mentions byok-copilot but says nothing about model requirements
  • reference/engines.md covers max-continuations and autopilot but not BYOK model configuration
  • Gap: No documentation of the model frontmatter field for BYOK workflows or the GH_AW_MODEL_AGENT_COPILOT variable in a BYOK context

Relevant docs: reference/frontmatter.md, reference/engines.md, reference/glossary.md
Status: ❌ New gap β€” no documentation of BYOK model requirement. Also tracked as a bug.


4. Copilot CLI 1.0.28 subcommand restructure (new gap, no issue filed)

From #26556: copilot config --help and copilot environment --help no longer work as direct subcommands. Users must use copilot help config and copilot help environment.

Current doc state:

  • reference/engines.md does not appear to reference copilot config or copilot environment directly
  • No known breakage in the docs, but any external guides/blog posts referencing the old syntax are now stale

Status: ⚠️ Low-severity β€” verify reference/engines.md and blog content does not reference old subcommand paths.


βœ… Issues Where Documentation Already Contains the Answer

#22001 β€” Add WorkQueueOps and BatchOps doc pages

Labels: documentation

Both pages exist and appear substantial:

  • docs/src/content/docs/patterns/workqueue-ops.md βœ…
  • docs/src/content/docs/patterns/batch-ops.md βœ…

Recommendation: Close #22001 with pointers to these two pages.


πŸ“Š Summary

Issue Title Status Relevant Doc
#16498 Provider-based auth (BYOK) ❌ Gap (2mo) reference/auth.mdx, reference/engines.md
#20391 115 stale v0.45.5 links in blog ❌ Gap (5wk) blog/ directory
#26565 (NEW) byok-copilot COPILOT_MODEL undocumented ❌ New gap + bug reference/frontmatter.md, reference/engines.md
(no issue) Copilot 1.0.28 subcommand restructure ⚠️ Low risk β€” verify docs reference/engines.md
#22001 WorkQueueOps and BatchOps pages βœ… Docs exist β€” can close patterns/workqueue-ops.md, patterns/batch-ops.md

🎯 Recommended Actions

  1. High priority: Document byok-copilot model requirement in reference/frontmatter.md and reference/engines.md β€” directly tied to live bug bug: byok-copilot feature generates empty COPILOT_MODEL fallback, breaking BYOK modeΒ #26565
  2. Medium priority: Close Add WorkQueueOps and BatchOps doc pages under design patternsΒ #22001 with pointers to patterns/workqueue-ops.md and patterns/batch-ops.md
  3. Medium priority: Continue tracking Provider-based authentication for Claude, Copilot, Codex.Β #16498 β€” auth docs are largely correct but BYOK model interaction is now a real user pain point
  4. Low priority: Automate version link updates in blog/ directory (Meet the workflows points to specific versions, need to keep these up to dateΒ #20391)
  5. Low priority: Verify no docs reference deprecated copilot config --help / copilot environment --help subcommand paths (Copilot 1.0.28 change)

Note

πŸ”’ Integrity filter blocked 16 items

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

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

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

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

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