Skip to content

[Daily Report] Daily Status Report β€” 2026-03-22Β #22297

@github-actions

Description

@github-actions

πŸ“š Documentation Quality β€” Daily Status Report

Date: 2026-03-22 | Scope: gh-aw documentation health


Summary

Category Count
Open documentation issues 3
Actionable bugs 1
Enhancement plans 2
Issues answerable by existing docs 0
Documentation gaps 1

πŸ”΄ Open Issues Reporting Documentation Problems

1. Broken Link β€” Architecture Page (404)

Issue: #22226 β€” πŸ” Multi-Device Docs Testing Report - 2026-03-22 [documentation, testing]

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+ pages in the nav sidebar.

Root cause identified 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 β€” exists and works at the correct URL with trailing slash. All other internal links already use the trailing slash form. This is a simple one-line fix.


2. Missing Engine Feature Comparison Table

Issue: #22147 β€” [plan] Add engine feature comparison table to engines reference docs [plan]

Problem: The engines.md reference page has a basic table listing engine name, engine: value, and required secret β€” but no comparison of feature support across engines (e.g. multi-file editing, tool allowlist support, MCP support, streaming, max context window).

Gap confirmed in: docs/src/content/docs/reference/engines.md
The page covers per-engine configuration in depth but has no cross-engine capability comparison. New users choosing an engine cannot tell what differs between Copilot, Claude, Codex, and Gemini beyond which secret is required.

Documentation section needed: A "Feature Comparison" table in engines.md (or a dedicated reference/engine-comparison.md).


3. Frontmatter Field Name Validation (Plan)

Issue: #22092 β€” [plan] Add frontmatter field name validation with did-you-mean suggestions [plan]

Problem: When a user typos a frontmatter field name, the compiler currently silently ignores it. The plan requests both a compiler feature (did-you-mean suggestions) and docs explaining valid field names.

Current docs: docs/src/content/docs/reference/frontmatter.md comprehensively lists all valid fields, but there is no guidance on what happens with unknown/misspelled fields and no troubleshooting entry for "my frontmatter setting isn't working."

Possible quick win: Add a note to troubleshooting/common-issues.md covering "frontmatter field not recognized" before the compiler feature lands.


βœ… Historical Improvement β€” Broken Links

Issues: #14287 (closed) & #14464 (closed) β€” Documentation Noob Test Reports (February 2026)

Both reports flagged 212 broken internal links blocking the docs build entirely in February. The latest testing report (#22226) now finds only 1 broken link, indicating the bulk of those issues were resolved. Documentation health has improved significantly since February.


πŸ—‚οΈ Cross-Reference: Open Issues vs. Current Documentation

Issue Doc File Assessment
#22226 Broken architecture link docs/index.mdx:47 βœ… Fix is trivial (add / to href)
#22147 Engine comparison table docs/reference/engines.md ❌ Gap β€” no comparison table exists
#22092 Frontmatter validation docs/reference/frontmatter.md + troubleshooting/common-issues.md ⚠️ Partial β€” fields documented but no "unknown field" guidance

No issues found where existing documentation already answers the question β€” all three open issues represent genuine gaps or actionable bugs.


Recommended Actions

  1. Quick fix (5 min): Add trailing slash to index.mdx FeatureCard href β€” resolves πŸ” Multi-Device Docs Testing Report - 2026-03-22Β #22226
  2. Short term: Add "unknown frontmatter field" entry to troubleshooting/common-issues.md β€” partially addresses [plan] Add frontmatter field name validation with did-you-mean suggestions for common mistakesΒ #22092
  3. 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-22

Note

**πŸ”’ Integrity filter blocked 38 items**

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

  • #20663 search_issues: has lower integrity than agent requires. The agent cannot read data with integrity below "approved".
  • #20646 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".
  • #20248 search_issues: has lower integrity than agent requires. The agent cannot read data with integrity below "approved".
  • #20241 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".
  • #19836 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".
  • #22161 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".
  • #18821 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".
  • #21871 search_issues: has lower integrity than agent requires. The agent cannot read data with integrity below "approved".
  • ... and 22 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 Β· β—·

  • expires on Mar 29, 2026, 6:00 PM UTC

Metadata

Metadata

Assignees

No one assigned

    Labels

    documentationImprovements or additions to documentationreport

    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