-
Notifications
You must be signed in to change notification settings - Fork 334
[Daily Report] Documentation Quality Report β April 7, 2026Β #25041
Description
Daily status report on documentation quality for the gh-aw project, cross-referenced against open issues.
π What Changed Since April 5
β Two plan issues closed (completed April 5):
- #24681 β Repo-memory stateful scanning example β
memory.mdupdated - #24682 β Pre-step data-fetching pattern β
create-agentic-workflow.mdupdated
π₯ New high-priority item today:
- #25014 β Copilot CLI 1.0.18 β 1.0.19 (major new features) introduces 18+ new flags and 14 new environment variables (BYOK,
--secret-env-vars,--no-ask-user,--output-format json, etc.) with zero coverage in current docs.
π Open Documentation Issues
1. #25014 β Copilot CLI 1.0.19: New flags & env vars undocumented (NEW β today)
Labels: automation, dependencies
Copilot CLI 1.0.19 adds significant new features with no documentation coverage in docs/src/content/docs/reference/engines.md or related pages:
- BYOK (Bring Your Own Key) via
COPILOT_PROVIDER_BASE_URL/COPILOT_PROVIDER_TYPE/COPILOT_PROVIDER_API_KEY --secret-env-varsβ strips secrets from MCP server environments (directly relevant to gh-aw security)--no-ask-userβ enables fully autonomous agentic runs--output-format jsonβ JSON/JSONL output for automation- Offline mode via
COPILOT_OFFLINE=true
Relevant docs: reference/engines.md, reference/auth.mdx, reference/environment-variables.md
Gap: No BYOK coverage exists anywhere in docs. New flags for agentic use cases (--no-ask-user, --secret-env-vars) are undocumented.
Status: β Documentation gap β new release with no doc updates.
2. #16498 β Provider-based authentication for Claude, Copilot, Codex
Labels: documentation, enhancement, security
CLAUDE_CODE_OAUTH_TOKEN is referenced in workflow code but barely documented. Provider-based authentication (OAuth, cloud-provider auth) for Claude, Codex, and Copilot engines is undocumented. Users need guidance on configuration and whether secrets are required.
Relevant docs: reference/auth.mdx, reference/engines.md
Gap: auth.mdx only mentions API key method. No OAuth or provider-based auth coverage.
Status: β Documentation gap β ongoing since Feb 2026. Now amplified by #25014 BYOK additions.
3. #22001 β Add WorkQueueOps and BatchOps pattern pages
Labels: documentation
No documentation covers work-queue and batching patterns β common use cases for agentic workflows. The issue outlines approaches (issue checklists, sub-issues, cache/repo memory, discussions) and batch operation strategies.
Relevant docs: patterns/ directory (daily-ops.md, issue-ops.md, task-ops.md exist)
Gap: No workqueue-ops.md or batch-ops.md pages.
Status: β Documentation gap β open since March 2026, unassigned.
4. #20391 β Version-pinned links in blog posts go stale
Labels: documentation, automation
Blog posts contain version-pinned gh aw add-wizard links (e.g., v0.45.5) that become stale. No automation validates or updates these links.
Relevant docs: blog/2026-01-13-meet-the-workflows-*.md (multiple files)
Gap: No automation exists to update version pins or validate versioned internal links.
Status: β Maintenance gap β ongoing.
5. #18821 β Settings for repositories with long build times
Labels: scout
Repos with 5β10 min build times (e.g., C++) can hit MCP/Bash tool timeouts or global resource constraints. No documentation covers timeout configuration across different coding agents in gh-aw workflows.
Relevant docs: reference/sandbox.md, guides/self-hosted-runners.md, troubleshooting/common-issues.md
Gap: No dedicated guidance on timeout/build-time settings per agent type.
Status: β Documentation gap β open since Feb 2026, no doc section addresses this.
β Issues Answered by Existing Docs
No open issues were found where current documentation already fully resolves the question.
π Summary
| Issue | Title | Since Last Report | Gap Type | Relevant Doc |
|---|---|---|---|---|
| #25014 | Copilot CLI 1.0.19 new flags & env vars | π New today | Missing coverage | reference/engines.md, reference/auth.mdx |
| #16498 | Provider-based auth (Claude/Codex/Copilot) | β Ongoing | Missing section | reference/auth.mdx, reference/engines.md |
| #22001 | WorkQueueOps & BatchOps patterns | β Ongoing | Missing pages | patterns/ directory |
| #20391 | Version-pinned blog links go stale | β Ongoing | Maintenance/automation | blog/ directory |
| #18821 | Settings for long build times | β Ongoing | Missing guidance | reference/sandbox.md |
| #24681 | Repo-memory stateful scanning example | β Closed Apr 5 | β | memory.md |
| #24682 | Pre-step data-fetching pattern | β Closed Apr 5 | β | create-agentic-workflow.md |
π― Recommended Actions
- High priority: Update
reference/engines.mdand/or add a newreference/byok.mdpage covering the Copilot CLI 1.0.19 BYOK and new flags relevant to agentic workflows ([ca] Update Copilot CLI: 1.0.18 β 1.0.19 (major new features)Β #25014) - Medium priority: Expand
reference/auth.mdxto cover provider-based and OAuth authentication (Provider-based authentication for Claude, Copilot, Codex.Β #16498) β now urgent given BYOK additions - Medium priority: Create
patterns/workqueue-ops.mdandpatterns/batch-ops.md(Add WorkQueueOps and BatchOps doc pages under design patternsΒ #22001) - Low priority: Add troubleshooting guidance for long-build-time repos (Review settings for using in repositories with long build timesΒ #18821)
Note
π Integrity filter blocked 24 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". - #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". - #20717
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". - #24961
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". - #24930
search_issues: has lower integrity than agent requires. The agent cannot read data with integrity below "approved". - #22914
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". - #21784
search_issues: has lower integrity than agent requires. The agent cannot read data with integrity below "approved". - #21403
search_issues: has lower integrity than agent requires. The agent cannot read data with integrity below "approved". - #21306
search_issues: has lower integrity than agent requires. The agent cannot read data with integrity below "approved". - #21188
search_issues: has lower integrity than agent requires. The agent cannot read data with integrity below "approved". - ... and 8 more items
To allow these resources, lower min-integrity in your GitHub frontmatter:
tools:
github:
min-integrity: approved # merged | approved | unapproved | noneGenerated by Dev Β· β 588.5K Β· β·
- expires on Apr 14, 2026, 9:10 AM UTC