Skip to content

[Daily Report] Documentation Quality Report β€” April 23, 2026Β #28015

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

One commit since April 22 β€” c292442 β€” feat: add agentic-optimization-kit workflow consolidating token audit, optimizer, and observability kit (#28009)

  • Adds .github/workflows/agentic-optimization-kit.md + compiled lock file
  • No documentation page added β€” see new gap below
  • Includes multiple changesets (rename safe-inputs β†’ mcp-scripts, various version bumps, concurrency fixes)

πŸ› 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 undocumented in docs/. The docs/reference/frontmatter.md covers BYOK mode and COPILOT_API_KEY / COPILOT_MODEL, but COPILOT_PROVIDER_* configuration has 0 occurrences in all docs.

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 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.

File Occurrences
2026-01-13-meet-the-workflows-testing-validation.md 12
2026-01-13-meet-the-workflows-documentation.md 14
2026-01-13-meet-the-workflows-metrics-analytics.md 6
2026-01-13-meet-the-workflows-issue-management.md 8
...and 6 more files ...

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.


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.


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.


πŸ†• New Gap Identified Today

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

The new agentic-optimization-kit workflow (weekly kit consolidating token audit, optimizer, and observability) was added in #28009 with no corresponding page in docs/src/content/docs/.

  • Similar workflows (agentic-observability-kit.md) have docs pages in docs/src/content/docs/patterns/
  • No entry in docs/src/content/docs/patterns/ for the new kit
  • Users discovering this workflow via GitHub Actions will have no documentation to reference

Relevant doc location to create: docs/src/content/docs/patterns/agentic-optimization-kit.md
Status: ❌ New gap β€” should be documented before users start using this workflow.


βœ… No Longer a Gap

  • MCP Scripts / safe-inputs rename: docs/reference/mcp-scripts.md exists and covers the renamed feature. The upgrading.md guide also documents the safe-inputs-to-mcp-scripts codemod migration.

Summary Table

Issue Title Status
#16498 COPILOT_PROVIDER_* vars undocumented ❌ Critical
#20391 115 stale v0.45.5 links in blog ❌ Ongoing
#27499 Prompt step density guidance missing πŸ”„ Unaddressed
#27501 Trigger cadence decision tree missing πŸ”„ Unaddressed
#27502 Bash allowlist decision rule undocumented πŸ”„ Unaddressed
(new) agentic-optimization-kit has no docs page ❌ New gap

Note

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

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