[Daily Report] Documentation Quality Report — April 11, 2026

[github-actions]

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

---

🆕 What Changed Since April 10

• [plan] Improve agentic workflow documentation for workflow_run triggers, external APIs, and Playwright network config #25425 closed (not_planned, Apr 11): The plan issue for workflow_run triggers, external APIs, and Playwright+network pairing was closed without implementation — the underlying gaps remain.
• [cli-tools-test] logs tool returns file_path to inaccessible directory /tmp/gh-aw-logs-cache/ #25758 opened (Apr 11, NEW): logs MCP tool writes cache files to /tmp/gh-aw-logs-cache/ which is inaccessible in the agent filesystem — agents get "No such file or directory" when following the tool's own instructions.
• Documentation workflow failures persist: Unbloat ([aw] Documentation Unbloat failed #25575), Noob Tester ([aw] Documentation Noob Tester failed #25305), Daily Healer ([aw] Daily Documentation Healer failed #25478), and Multi-Device Tester ([aw] Multi-Device Docs Tester failed #25465) all failed this week, interrupting the automated docs quality loop.

---

🐛 Open Documentation Issues

1. #16498 — Provider-based auth for Claude, Copilot, Codex (open since Feb 2026)

Labels: documentation, enhancement, security

Copilot CLI 1.0.19 introduced full BYOK (Bring Your Own Key) support via COPILOT_PROVIDER_BASE_URL, COPILOT_PROVIDER_TYPE, and COPILOT_PROVIDER_API_KEY. None of these appear in the docs.

Verified gaps:

• reference/engines.md — no mention of COPILOT_PROVIDER_* or BYOK
• reference/environment-variables.md — no COPILOT_PROVIDER_* entries
• reference/auth.mdx — correctly documents Claude OAuth as unsupported, but Copilot BYOK is absent

Status: ❌ Active gap — Copilot BYOK entirely undocumented despite 1.0.19 release.

---

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

Labels: documentation, automation, workflows

All install links in the "Meet the Workflows" blog series still reference v0.45.5:

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

Confirmed in blog/2026-01-13-meet-the-workflows-testing-validation.md (and other blog files). These links are not covered by internal link checking.

Status: ❌ Ongoing gap — version links stale, no automated validation.

---

3. #25758 — logs tool returns inaccessible file_path (new, Apr 11)

Labels: automation, testing, cli-tools

The logs MCP tool returns a file_path pointing to /tmp/gh-aw-logs-cache/<hash>.json and instructs agents to "Use the file_path to read the full data." The directory doesn't exist in the agent's filesystem, causing immediate failure.

The system prompt correctly describes /tmp/gh-aw/aw-mcp/logs/ (accessible), but the tool's own response points agents to the wrong path.

Relevant docs: reference/audit.md — documents gh aw logs and audit functionality
Gap: No documentation or inline tool guidance clarifies which paths are agent-accessible vs. internal to the MCP server.
Status: ❌ New gap — tool behavior and documentation contradict each other.

---

4. #20391 sub-gap — Playwright + network config pairing

Plan #25425 (now closed) identified that network: { allowed: [defaults, playwright] } pairing is not prominently documented. The plan was closed without implementation.

Relevant docs: reference/playwright.md, reference/network.md
Status: ⚠️ Gap remains — plan closed without fix.

---

5. #22001 — WorkQueueOps and BatchOps pages (can close)

Labels: documentation

Both pages now exist and are non-trivial:

• patterns/workqueue-ops.md — 144 lines
• patterns/batch-ops.md — 213 lines

This issue can be closed with pointers to the two pattern pages.
Status: ✅ Documentation exists — issue #22001 can be closed.

---

📊 Summary

Issue	Title	Status
#16498	Provider-based auth / Copilot BYOK undocumented	❌ Gap
#20391	Meet the Workflows stale v0.45.5 links	❌ Gap
#25758	logs tool inaccessible file_path	❌ New gap
Playwright+network	Missing [defaults, playwright] example	⚠️ Gap (plan closed)
#22001	WorkQueueOps and BatchOps pages	✅ Can close

1 issue can be closed (docs exist): #22001
4 active documentation gaps: #16498 (BYOK), #20391 (version links), #25758 (logs tool path), Playwright+network pairing

---

🔧 Documentation Workflow Health

4 documentation automation workflows failed this week:

Workflow	Issue	Failure type
Documentation Unbloat	#25575	Claude engine timeout (1511s)
Documentation Noob Tester	#25305	Copilot engine exit code 1
Daily Documentation Healer	#25478	Unspecified engine failure
Multi-Device Docs Tester	#25465	Unspecified engine failure

The Unbloat failure is particularly notable: the Claude session ran for 1511 seconds before the MCP connection closed, suggesting a timeout or resource limit rather than a logic error. The automated documentation quality loop is effectively paused until these workflows are restored.

---

🔍 Documentation Structure Health

147 documentation files across docs/src/content/docs/ — overall structure is sound. Priority areas:

• reference/engines.md and reference/environment-variables.md: Need Copilot CLI 1.0.19 BYOK updates (14 new env vars, multiple new flags)
• reference/playwright.md / reference/network.md: Need network: { allowed: [defaults, playwright] } example
• blog/2026-01-13-meet-the-workflows-*.md: Need version link updates from v0.45.5 → latest

Note

🔒 Integrity filter blocked 11 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".
• #24949 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".
• #25767 search_issues: has lower integrity than agent requires. The agent cannot read data with integrity below "approved".
• #25768 search_issues: has lower integrity than agent requires. The agent cannot read data with integrity below "approved".
• #20593 issue_read: has lower integrity than agent requires. The agent cannot read data with integrity below "approved".
• #24961 issue_read: 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 · ● 786K · ◷

• expires on Apr 18, 2026, 9:04 AM UTC