[docs] Self-healing documentation fixes from issue analysis - 2026-05-28#35330
[docs] Self-healing documentation fixes from issue analysis - 2026-05-28#35330github-actions[bot] wants to merge 1 commit into
Conversation
Closes #34686. Adds the two missing frontmatter reference sections that the JSON Schema's `See:` links pointed to, and updates the schema URLs to match the actual anchor slugs Astro Starlight generates from the new headings. Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com>
This PR adds documentation for two existing frontmatter fields that were referenced in the JSON Schema but had no corresponding reference section in the docs (causing broken anchor links):
The schema |
Self-Healing Documentation Fixes
This PR was automatically created by the Daily Documentation Healer workflow.
Gaps Fixed
Update Check (check-for-updates:)andInstall Scripts (run-install-scripts:)reference sections todocs/src/content/docs/reference/frontmatter.md, and updated the corresponding schemaSee:URLs inpkg/parser/schemas/main_workflow_schema.json(and the generatedfrontmatter-full.md) to point at the actual Starlight anchor slugs (#update-check-check-for-updatesand#install-scripts-run-install-scripts). The third anchor flagged by the issue,#strict-mode-strict, already exists and was not touched.Root Cause
The broken anchors were not caught by DDUw because:
### 4.indaily-doc-updater.md) looks for missing pages but does not validate that anchor fragments referenced from outside the docs (schema, source comments) resolve to a real heading inside the docs.### 1c.) was performed, but issue [deep-report] [quick-win] Fix 3 broken doc-link anchors in main_workflow_schema.json #34686 was auto-closed by expiry (the DeepReport trackergh-aw-expiresmechanism), not via a[docs]PR that resolved it. DDUw’s current heuristic treats any closure as a signal of resolution unless a same-window merged PR explicitly references the issue. Expiry-based closures ofdeep-reportand similar tracker issues therefore look identical to resolved closures and slip past the recently-closed-issue check.💡 DDUw Improvement Suggestions
DDUw Improvement Suggestions
The following targeted changes to
.github/workflows/daily-doc-updater.mdwould prevent this class of gap from recurring:Add an anchor-integrity scan step (new sub-step inside
### 4. Identify Documentation Gaps):https://github.github.com/gh-aw/reference/<page>/#<anchor>URL found inpkg/parser/schemas/*.jsonand inpkg/**/*.godoc comments, verify a heading whose Starlight slug equals<anchor>exists in the correspondingdocs/src/content/docs/reference/<page>.md.Tighten the closed-issue heuristic in
### 1c.to distinguish expiry-based auto-closures from resolution-based closures:documentationissue as “already addressed,” check whether the issue body contains agh-aw-expiresHTML comment with a timestamp in the past.#NNN,closes #NNN, etc.), treat the issue as unaddressed, not resolved.[deep-report]and[doc-healer]tracker issues, which auto-close on expiry rather than on fix.Add the JSON Schema to DDUw's primary watch list. Currently
pkg/parser/schemas/*.jsonis listed undertools.bash(so it can be read) but the analysis steps never explicitly diff it for outbound documentation links. Adding a step like “Diffmain_workflow_schema.jsonfor new/changedSee:URLs and verify each anchor resolves” would have caught these broken anchors the day they were introduced.Related Issues
Closes #34686