Skip to content

[docs] Self-healing documentation fixes from issue analysis - 2026-10-04 - #65687

Merged
pelikhan merged 1 commit into
mainfrom
doc-healer/quick-start-heading-hierarchy-2026-10-04-f922a91fe5331159
Oct 5, 2026
Merged

pelikhan merged 1 commit into
mainfrom
doc-healer/quick-start-heading-hierarchy-2026-10-04-f922a91fe5331159

Conversation

@github-actions

@github-actions github-actions Bot commented Oct 4, 2026

Copy link
Copy Markdown
Contributor

Self-Healing Documentation Fixes

This PR was automatically created by the Daily Documentation Healer workflow.

Gaps Fixed

  • Issue [deep-report] Fix confusing heading hierarchy in Quick Start doc (quick-start.mdx) #64947 ([deep-report] Fix confusing heading hierarchy in Quick Start doc) — docs/src/content/docs/setup/quick-start.mdx had a misleading H3 "YAML frontmatter" wrapping generic intro text (not a frontmatter reference), and "Prerequisites" nested Steps 1-4 as H3 sub-items, making the TOC show the actual walkthrough as a sub-section of the prerequisites list. Un-nested the intro paragraph and promoted Steps 1-4 to top-level H2 headings; demoted the no-longer-orphaned "Configuring authentication" to H3 under Step 2. Verified no other page links to the removed #yaml-frontmatter anchor.
Issues reviewed but not acted on

Root Cause

Issue #64947 carries the cookie, improvement, and quick-win labels and was closed not_planned, which should route it through DDUw Step 1c's "Cross-cutting docs-coverage / convention gaps" path. That path's example list ("example parity across multiple reference pages, consistent terminology, missing cross-links") only illustrates gaps that span multiple pages. A single-page heading-hierarchy/structure defect — exactly this issue's content — doesn't obviously match those examples, so DDUw's own run on 2026-10-04 (after the issue closed at 08:41 UTC) appears to have judged it as not "cross-cutting" and skipped it, even though the labels matched the gate.

💡 DDUw Improvement Suggestions

DDUw Improvement Suggestions

  1. Broaden Step 1c's "cross-cutting docs-coverage / convention gaps" example list to explicitly include single-page structural issues (heading hierarchy, TOC nesting, information architecture within one file), not just gaps that span multiple reference pages — the current wording reads as multi-page-only and likely causes false negatives for single-page convention defects that still carry the qualifying labels.
  2. Consider adding "heading hierarchy depth/nesting" as a named example category alongside "example parity" and "consistent terminology" so this specific, mechanically-verifiable defect type (an H3 immediately following an H2 that holds unrelated content, or step-by-step content nested under an unrelated parent heading) is recognized without requiring a judgment call.

Related Issues

Generated by 📝 Daily Documentation Healer · claude · sonnet50 · 346.7 AIC · ⌖ 28.7 AIC · ⊞ 6.6K · ◷

  • expires on Oct 7, 2026, 3:55 PM UTC-08:00

Un-nest the intro paragraph from a misleading "YAML frontmatter" H3
and promote Steps 1-4 to top-level H2s so the TOC no longer shows
them as sub-items of "Prerequisites".

Closes #64947

Co-Authored-By: Claude Sonnet 5 <noreply@anthropic.com>
@github-actions github-actions Bot added automation documentation Improvements or additions to documentation labels Oct 4, 2026
@pelikhan
pelikhan marked this pull request as ready for review October 5, 2026 04:14
Copilot AI balanced review requested due to automatic review settings October 5, 2026 04:14
@pelikhan
pelikhan merged commit 2fcb5c8 into main Oct 5, 2026
2 checks passed
@pelikhan
pelikhan deleted the doc-healer/quick-start-heading-hierarchy-2026-10-04-f922a91fe5331159 branch October 5, 2026 04:14
@github-actions

github-actions Bot commented Oct 5, 2026 •

Copy link
Copy Markdown
Contributor Author

✅ Test Quality Sentinel completed test quality analysis.

No test files were added or modified in this PR. Test Quality Sentinel skipped. PR contains documentation fixes only (quick-start.mdx).

🧪 Test quality analysis by Test Quality Sentinel

Copilot AI left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Copilot review overview

🟢 Approval recommended

The heading-only changes correctly resolve the reported navigation issue without leaving broken anchor references.

Review effort: Balanced
Findings: None

What changed in this PR

Clarifies the Quick Start table of contents and heading hierarchy.

Changes:

  • Promotes walkthrough steps to H2 headings.
  • Nests authentication guidance under Step 2.
  • Removes the obsolete YAML-frontmatter heading and anchor link.
File Description
docs/​src/​content/​docs/​setup/​quick-start.mdx Corrects tutorial heading structure and removes a stale internal anchor.

💡 Add a code-review agent skill for context-aware, tailored reviews. Learn more in the docs.

@github-actions

github-actions Bot commented Oct 5, 2026

Copy link
Copy Markdown
Contributor Author

🎉 This pull request is included in a new release.

Release: v0.91.0

@github-actions github-actions Bot mentioned this pull request Oct 6, 2026
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

automation documentation Improvements or additions to documentation

Projects

None yet

Development

Successfully merging this pull request may close these issues.

[deep-report] Fix confusing heading hierarchy in Quick Start doc (quick-start.mdx)

2 participants