-
Notifications
You must be signed in to change notification settings - Fork 312
Description
π Documentation Quality β Daily Status Report
Date: 2026-03-23 | Scope: gh-aw documentation health
Note: The
qmdindex tool was unavailable (ANSI escape code parse error). Documentation cross-referencing was performed by directly inspecting files indocs/src/content/docs/.
Summary
| Category | Count |
|---|---|
| Open documentation issues (high-integrity) | 3 |
| Actionable bugs (broken links) | 1 |
| Enhancement plans | 2 |
| Issues answerable by existing docs | 0 |
| Documentation gaps | 2 |
| Plan issues expiring today | 2 |
π΄ Open Issues Reporting Documentation Problems
1. Broken Link β Architecture Page (404) β οΈ Still Unresolved
Issue: #22226 β π Multi-Device Docs Testing Report - 2026-03-22 [documentation, testing]
Status: Unchanged since yesterday's report. The broken link persists.
Problem: The homepage FeatureCard links to /gh-aw/introduction/architecture without a trailing slash. Since Astro is configured with trailingSlash: 'always', this returns HTTP 404 and affects 8+ navigation pages.
Confirmed in: docs/src/content/docs/index.mdx:47
<FeatureCard icon="shield-lock" title="Safety First" href="/gh-aw/introduction/architecture">Should be:
<FeatureCard icon="shield-lock" title="Safety First" href="/gh-aw/introduction/architecture/">Corresponding doc: docs/src/content/docs/introduction/architecture.mdx β file exists at the correct URL. This is a one-line fix.
2. Missing Engine Feature Comparison Table π Plan Expiring Today
Issue: #22147 β [plan] Add engine feature comparison table to engines reference docs [plan]
Status: Expires 2026-03-23T15:32:40Z (today). No progress since creation.
Problem: docs/src/content/docs/reference/engines.md covers per-engine configuration but has no cross-engine capability comparison. Users cannot determine which engines support max-turns, plugins, web-search, web-fetch, etc. without reading engine-specific code.
Confirmed gap: Searched engines.md β no feature comparison table or Supports*() method documentation exists.
Documentation needed: A "Feature Support" table in engines.md comparing Copilot, Claude, Codex, and Gemini across key capabilities.
3. Frontmatter Field Name Validation (Plan) π Plan Expired Today
Issue: #22092 β [plan] Add frontmatter field name validation with did-you-mean suggestions [plan]
Status: Expired 2026-03-23T05:06:31Z (earlier today). Plan was for both compiler feature + documentation.
Problem: Users using agent: instead of engine:, mcp-servers: instead of tools:, or tool-sets: instead of toolsets: get no feedback β the compiler silently ignores unknown fields.
Current docs status: docs/src/content/docs/troubleshooting/common-issues.md line 90 mentions frontmatter syntax checking in general but has no "unknown field names" section. docs/src/content/docs/reference/frontmatter.md lists valid fields but gives no warning about misspellings.
Quick documentation win available: Add a "Common Frontmatter Field Name Mistakes" callout to troubleshooting/common-issues.md before the compiler feature lands.
ποΈ Cross-Reference: Open Issues vs. Current Documentation
| Issue | Status | Doc File | Assessment |
|---|---|---|---|
| #22226 Broken architecture link | π΄ Open, unresolved | docs/index.mdx:47 |
β
Trivial one-line fix (add / to href) |
| #22147 Engine comparison table | π‘ Open, plan expiring today | docs/reference/engines.md |
β Gap β no comparison table exists |
| #22092 Frontmatter field validation | π‘ Open, plan expired today | docs/reference/frontmatter.md + troubleshooting/common-issues.md |
No issues found where existing documentation already fully answers the question. All three open issues represent genuine gaps or actionable bugs.
π Trend vs. Yesterday (2026-03-22 β #22297)
| Metric | Yesterday | Today | Change |
|---|---|---|---|
| Open doc issues | 3 | 3 | β No change |
| Broken links | 1 | 1 | β #22226 unresolved |
| Plan issues expiring | 0 | 2 |
The broken link from #22226 has not been fixed in 24 hours. The two plan issues (#22092 and #22147) are reaching their 2-day expiry today without being acted upon.
Recommended Actions
- Quick fix (5 min): Add trailing slash to
docs/src/content/docs/index.mdx:47FeatureCard href β resolves π Multi-Device Docs Testing Report - 2026-03-22Β #22226 - Short term: Add "Common Frontmatter Field Name Mistakes" callout to
troubleshooting/common-issues.mdβ partially addresses [plan] Add frontmatter field name validation with did-you-mean suggestions for common mistakesΒ #22092 (no compiler work needed) - Medium term: Add engine feature comparison table to
engines.mdβ addresses [plan] Add engine feature comparison table to engines reference docsΒ #22147
Generated by Daily Status Report workflow β 2026-03-23
Note
π Integrity filter blocked 5 items
The following items were blocked because they don't meet the GitHub integrity level.
search_issuessearch_issues: has lower integrity than agent requires. The agent cannot read data with integrity below "approved".- #20391
search_issues: has lower integrity than agent requires. The agent cannot read data with integrity below "approved". - #20207
search_issues: has lower integrity than agent requires. The agent cannot read data with integrity below "approved". - #16498
search_issues: has lower integrity than agent requires. The agent cannot read data with integrity below "approved". - #21529
search_issues: 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 | noneGenerated by Dev for issue #22183 Β· β·
- expires on Mar 30, 2026, 1:17 AM UTC