Skip to content

[Daily Report] Documentation Quality Report β€” April 24, 2026Β #28225

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

One commit since April 23 β€” 0775d65 β€” fix: disallow --name flag when adding multiple workflows at once (#28195)

  • No documentation changes. All previously reported gaps remain open.

πŸ› Open Documentation Issues

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

Labels: documentation, enhancement, security, cli

COPILOT_PROVIDER_* env variables remain completely undocumented β€” 0 occurrences in all of docs/. Users wanting to use Azure/Anthropic/OpenAI custom model providers have no guidance.

Relevant docs to update: reference/auth.mdx, reference/engines.md, reference/environment-variables.md
Status: ❌ Critical gap β€” BYOK shipped 2+ months ago; COPILOT_PROVIDER_ variables still undocumented.*


2. #20391 β€” Stale v0.45.5 version links in blog posts (open since March 2026)

Labels: documentation, automation, workflows

115 occurrences of v0.45.5 remain across 10 blog post files in docs/src/content/docs/blog/. No automation exists to keep version links current.

Status: ❌ Ongoing β€” 115 stale install links, unaddressed 7+ weeks.


3. #27499 β€” Improve prompt step density guidance (filed Apr 21)

No "Prompt Authoring" section in .github/aw/create-agentic-workflow.md. Dense multi-step prompt patterns have no documented structure guidance.

Status: πŸ”„ Unaddressed β€” third consecutive day.


4. #27501 β€” Add trigger cadence clarifying question (filed Apr 21)

No cadence decision tree for choosing between incident-response and daily-digest trigger frequencies.

Status: πŸ”„ Unaddressed β€” third consecutive day.


5. #27502 β€” Document bash allowlist decision rule (filed Apr 21)

Zero documentation on when to use a narrow bash allowlist vs. ["*"]. Security-sensitive for PR/issue-triggered workflows processing untrusted input.

Status: πŸ”„ Unaddressed β€” third consecutive day.


6. agentic-optimization-kit workflow β€” No documentation page (gap first noted Apr 23)

The workflow at .github/workflows/agentic-optimization-kit.md was added in #28009 with no corresponding page in docs/src/content/docs/patterns/. Comparable workflows (e.g., agentic-observability-kit.md) each have a dedicated docs page.

Relevant doc location to create: docs/src/content/docs/patterns/agentic-optimization-kit.md
Status: ❌ Gap persists β€” second consecutive day.


⚠️ Expiring Issue

#27823 β€” Mobile code block overflow on landing page (expires today, Apr 24)

Mobile viewports <560px clip the YAML code example on the landing page due to overflow-x: hidden at the body level. All 4 mobile devices tested (360–428px) show this warning. The issue expires today without being addressed.

Recommendation: Before expiry, either shorten the longest YAML lines in the landing page example or add overflow-x: auto to the code block container at mobile breakpoints.
Status: ⏰ Expires today β€” unaddressed.


βœ… Issues Where Documentation Already Has the Answer

Issue Status
#22001 WorkQueueOps/BatchOps pages Both pages exist (workqueue-ops.md, batch-ops.md). Recommended for closure in Apr 22 + Apr 23 reports β€” still open.
#27777 max_tokens in audit/compile API docs are correct; testing guidelines contain the wrong guidance.

πŸ“Š Summary Table

Issue Type Docs Exist? Action Needed Age
#16498 BYOK auth vars undocumented Missing content ❌ 0 occurrences Add COPILOT_PROVIDER_* to reference/auth.mdx + engines.md 2+ months
#20391 Stale v0.45.5 blog links Stale content ❌ 115 stale links Automate version link updates 7+ weeks
#27499 Prompt step density guidance Missing content ❌ None Add "Prompt Authoring" section to create-agentic-workflow.md 3 days
#27501 Trigger cadence decision tree Missing guidance ❌ None Add decision tree near trigger selection section 3 days
#27502 Bash allowlist security guidance Missing security docs ❌ None Add narrow vs. ["*"] decision rule to bash tool docs 3 days
#27823 Mobile code block overflow UX/rendering ⚠️ Cosmetic Fix overflow-x on mobile viewports β€” expires today 2 days
#22001 WorkQueueOps/BatchOps pages Already resolved βœ… Pages exist Close issue β€” docs delivered Apr 18 5 weeks
(new Apr 23) agentic-optimization-kit Missing page ❌ No docs page Create docs/src/content/docs/patterns/agentic-optimization-kit.md 1 day

Report generated 2026-04-24

Note

πŸ”’ Integrity filter blocked 9 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 Β· ● 689.2K Β· β—·

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