Skip to content

[Daily Report] Documentation Quality Report — April 30, 2026 #29278

@github-actions

Description

@github-actions

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


Open Documentation Issues

Label: documentation

# Title Age Status
#16498 Provider-based authentication for Claude, Copilot, Codex ~10 weeks ⚠️ Partially addressed
#20391 Meet the workflows points to specific versions ~7 weeks ❌ Still open
#22001 Add WorkQueueOps and BatchOps doc pages ~6 weeks ✅ Can close — docs exist
#29045 Add workflow_run trigger examples to create-agentic-workflow.md 1 day ✅ Already documented

Analysis

✅ Issues That Can Be Closed (Documentation Already Exists)

#22001 — Add WorkQueueOps and BatchOps doc pages
Both requested pages now exist:

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

This issue can be closed with pointers to those pages.

#29045 — Add workflow_run trigger examples to create-agentic-workflow.md
The .github/aw/create-agentic-workflow.md file (and the engines reference) already contains multiple workflow_run examples, including failure detection patterns and DevOps monitoring guidance. The plan task appears stale.


⚠️ Partially Addressed

#16498 — Provider-based authentication
docs/src/content/docs/reference/auth.mdx now clearly states that CLAUDE_CODE_OAUTH_TOKEN is not supported and redirects users to ANTHROPIC_API_KEY. However, the issue also asked about:

  • Provider-based auth for Codex and Copilot engines — not addressed
  • Impact on gh aw secrets bootstrap / gh aw add-wizard for zero-secret BYOK setups — not addressed

Relevant docs to update: docs/src/content/docs/reference/auth.mdx, docs/src/content/docs/reference/engines.md


❌ Open Gap

#20391 — Stale version links in blog posts
Version-pinned links like gh aw add-wizard https://github.com/github/gh-aw/blob/v0.45.5/... in blog/documentation remain hard-coded. No automated link-update mechanism exists yet.

Relevant section: Blog posts + any version-pinned install instructions across docs


Recent Commits With Undocumented Features (April 29–30)

The following merged PRs introduced features where docs may lag:

PR Feature Docs
#29235, #29230 Parameterize safe-output boolean/PR-policy controls for reusable workflows ❓ Not confirmed in safe-outputs.md
#29212 GitHub Actions expressions for list-valued safe-output constraints ✅ Already reflected in safe-outputs.md lines 1054–1055, 1324–1328
#29170 --stdin flag added to logs and audit commands ❌ Not found in docs/reference/audit.md
#29153 recreate-ref option in create_pull_request ✅ Documented in safe-outputs-pull-requests.md
#29225 New .github/aw/skills.md guide ✅ Internal agentic context file, no public doc needed

Priority gap: The --stdin flag for gh aw logs and gh aw audit (#29170) has no corresponding doc entry in docs/src/content/docs/reference/audit.md.


Summary

Category Count
Issues closeable (docs already cover it) 2 (#22001, #29045)
Issues partially addressed 1 (#16498)
Issues with no doc coverage 1 (#20391)
Recent features missing docs 1 (--stdin flag, #29170)

Generated by Documentation Quality workflow

Note

🔒 Integrity filter blocked 19 items

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

  • #21784 search_issues: has lower integrity than agent requires. The agent cannot read data with integrity below "approved".
  • #22533 search_issues: has lower integrity than agent requires. The agent cannot read data with integrity below "approved".
  • #29172 search_issues: has lower integrity than agent requires. The agent cannot read data with integrity below "approved".
  • #29173 search_issues: has lower integrity than agent requires. The agent cannot read data with integrity below "approved".
  • #29174 search_issues: has lower integrity than agent requires. The agent cannot read data with integrity below "approved".
  • #20593 search_issues: has lower integrity than agent requires. The agent cannot read data with integrity below "approved".
  • #27886 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".
  • #28963 search_issues: has lower integrity than agent requires. The agent cannot read data with integrity below "approved".
  • #19611 search_issues: has lower integrity than agent requires. The agent cannot read data with integrity below "approved".
  • #29171 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".
  • #29240 search_issues: has lower integrity than agent requires. The agent cannot read data with integrity below "approved".
  • #17352 search_issues: has lower integrity than agent requires. The agent cannot read data with integrity below "approved".
  • #29189 search_issues: has lower integrity than agent requires. The agent cannot read data with integrity below "approved".
  • #17969 search_issues: has lower integrity than agent requires. The agent cannot read data with integrity below "approved".
  • ... and 3 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.2M ·

  • expires on May 7, 2026, 9:32 AM UTC

Metadata

Metadata

Assignees

No one assigned

    Labels

    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