-
Notifications
You must be signed in to change notification settings - Fork 316
Description
π Documentation Quality β Daily Status Report
Date: 2026-03-23 | Edition: Evening (20:32 UTC)
Previous reports today: #22350 (01:17 UTC) β #22365 (03:09 UTC) β #22423 (12:31 UTC, "Final")
Summary
| Category | Count |
|---|---|
| Resolved since last report | 1 β |
| Open documentation issues | 0 π |
| New documentation issues (since 12:31 UTC) | 0 |
| DX issues with documentation implications | 1 |
| Prior-report gaps re-assessed as already fixed | 1 β |
β Resolved Since Last Report (12:31 UTC)
FeatureGrid Overflow on iPad Pro 11 β FIXED β
Issue: #22363 β π Multi-Device Docs Testing Report - 2026-03-23
Closed: 2026-03-23T17:02 UTC β completed
The .feature-grid.columns-3 breakpoint in docs/src/components/FeatureGrid.astro was raised from 50rem to 72rem, resolving the card-clipping issue at 834px viewport width (iPad Pro 11). 9/10 devices were already passing; this clears the remaining warning device.
π Re-Assessment: Prior-Reported Gap Already Filled
"Common Frontmatter Mistakes" β ALREADY DOCUMENTED β
Issue #22423 claimed: "The documentation gap (no 'common mistakes' section in troubleshooting/common-issues.md) remains unfilled."
Actual state on disk today:
docs/src/content/docs/troubleshooting/common-issues.md lines 90β103 already contains a "Common Frontmatter Field Name Mistakes" warning callout with a correction table:
| Wrong | Correct |
|---|---|
agent: |
engine: |
mcp-servers: |
tools: |
tool-sets: |
toolsets: (under tools.github:) |
allowed_repos: |
allowed-repos: |
timeout: |
timeout-minutes: |
This section was present in the repository. The prior report appears to have checked an outdated copy. No action needed.
β οΈ DX Issue with Documentation Implications
Compiler Error Messages Below Quality Threshold β #22484
Issue: [syntax-error-quality] Improve compiler error messages for YAML syntax errors and permission scope validation
Created: 2026-03-23T18:15 UTC | Status: Open
An automated quality analysis scored three error categories:
| Test Case | Score | Threshold |
|---|---|---|
| YAML syntax error (missing colon) | 41/100 β | 55 |
| Invalid engine name typo | 85/100 β | 70 |
| Invalid permission scope | 68/100 |
70 |
Documentation cross-reference:
docs/src/content/docs/troubleshooting/errors.md already documents "Failed to Parse Frontmatter" with correct-syntax examples. However:
- The compiler's raw YAML error output (
unexpected key name) does not point users to that doc page docs/src/content/docs/reference/permissions.mddocuments all valid scopes, but permission scope errors lack aSee:link to that page
Gap: The error messages themselves don't link to the relevant existing documentation. The fix is in the compiler (pkg/parser/yaml_error.go, pkg/parser/schema_errors.go), not in the docs β but the connection would improve DX significantly.
Recommended compiler additions (from #22484):
- Translate
"unexpected key name"β"missing ':' after key β YAML mapping entries require 'key: value' format" - Add
See: https://github.com/github/gh-aw/docs/...troubleshooting/errors/to YAML errors - Add
"Did you mean?"spell-check (using existingFindClosestMatches()) to permission scope errors - Add
See:link to GitHub Actions permissions docs in scope errors
ποΈ Cross-Reference: Issues vs. Documentation
| Issue | Relevant Doc | Assessment |
|---|---|---|
| #22363 FeatureGrid overflow | docs/src/components/FeatureGrid.astro |
β Fixed at 17:02 UTC |
| #22484 YAML syntax errors | troubleshooting/errors.md |
|
| #22484 Permission scope errors | reference/permissions.md |
Did you mean? + See: link |
| Frontmatter field mistakes (#22092 gap) | troubleshooting/common-issues.md |
β Section already present (lines 90β103) |
π Day-End Trend (2026-03-23)
| Metric | Start of Day | End of Day | Change |
|---|---|---|---|
| Open doc issues | 3 | 0 | β All resolved |
| Broken links | 1 | 0 | β Fixed |
| Missing doc sections | 2 | 0 | β Both already addressed |
| WCAG gaps | 1 | 0 | β Resolved with #22363 |
| Stuck automation loops | 1 | 0 | β #22363 is closed |
| Compiler error DX gaps | 0 | 1 |
Remaining Actions
- Compiler fix β Add YAML error translation layer + doc links in
pkg/parser/yaml_error.goβ improves YAML error score from 41 β 70+ ([syntax-error-quality] Improve compiler error messages for YAML syntax errors and permission scope validationΒ #22484) - Compiler fix β Add
FindClosestMatches()+See:link to permission scope errors inpkg/parser/schema_errors.goβ improves permission error score from 68 β 75+ ([syntax-error-quality] Improve compiler error messages for YAML syntax errors and permission scope validationΒ #22484)
Note: The
qmdvector search index was unavailable in this environment (requiresbunruntime). Documentation cross-referencing was performed by direct file inspection ofdocs/src/content/docs/.
Generated by Daily Status Report workflow β 2026-03-23 20:32 UTC
Warning
β οΈ Firewall blocked 1 domain
The following domain was blocked by the firewall during workflow execution:
proxy.golang.org
To allow these domains, add them to the network.allowed list in your workflow frontmatter:
network:
allowed:
- defaults
- "proxy.golang.org"See Network Configuration for more information.
Note
π Integrity filter blocked 26 items
The following items were blocked because they don't meet the GitHub integrity level.
- upload-asset safe output doesn't work for private reposΒ #22510
list_issues: has lower integrity than agent requires. The agent cannot read data with integrity below "approved". - mark_pull_request_as_ready_for_review handler uses REST API which cannot undraft PRsΒ #22469
list_issues: has lower integrity than agent requires. The agent cannot read data with integrity below "approved". - create_code_scanning_alert may be brokenΒ #22430
list_issues: has lower integrity than agent requires. The agent cannot read data with integrity below "approved". - Option
staged: truedoes not work within individual safe outputsΒ #22409list_issues: has lower integrity than agent requires. The agent cannot read data with integrity below "approved". - conclusion job reports missing agent_output.json instead of the actual engine failureΒ #22380
list_issues: has lower integrity than agent requires. The agent cannot read data with integrity below "approved". - Agentic Workflows Double PostingΒ #22362
list_issues: has lower integrity than agent requires. The agent cannot read data with integrity below "approved". - safe-outputs prompt says "exactly one" even when config allows multiple callsΒ #22364
list_issues: has lower integrity than agent requires. The agent cannot read data with integrity below "approved". - Custom API Endpoints doesn't workΒ #20997
list_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". - #20593
search_issues: has lower integrity than agent requires. The agent cannot read data with integrity below "approved". - #22110
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". - #20391
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". - #20508
search_issues: has lower integrity than agent requires. The agent cannot read data with integrity below "approved". - #20514
search_issues: has lower integrity than agent requires. The agent cannot read data with integrity below "approved". - ... and 10 more items
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, 8:36 PM UTC