Skip to content

Enforce docs heading hierarchy - #405

Open
Alek99 wants to merge 2 commits into
mainfrom
agent/fix-397-docs-heading-outline
Open

Enforce docs heading hierarchy#405
Alek99 wants to merge 2 commits into
mainfrom
agent/fix-397-docs-heading-outline

Conversation

@Alek99

@Alek99 Alek99 commented Jul 31, 2026

Copy link
Copy Markdown
Member

What changed

  • Promoted the Modebars page's top-level sections from H3 to H2.
  • Promoted the benchmark demo heading to H2 so visible demo content fits the page outline.
  • Added an all-public-route heading-order validator plus a negative first-H3 regression test.

Why

The two affected routes skipped directly from H1 to H3, weakening the semantic outline used by assistive technology and generated navigation.

Impact

Public documentation headings now advance by at most one level, and future route-level heading jumps fail the docs suite.

Validation

  • docs/app/.venv/bin/pytest -q docs/app/tests/test_heading_outline.py — 2 passed
  • docs/app/.venv/bin/python docs/app/scripts/check_heading_outline.py
  • Ruff lint and format checks on changed Python files

Fixes #397

Review in cubic

@coderabbitai

coderabbitai Bot commented Jul 31, 2026

Copy link
Copy Markdown

Warning

Review limit reached

@Alek99, you've reached your PR review limit, so we couldn't start this review.

Next review available in: 22 minutes

Enable usage-based reviews in Billing to review now. Otherwise, wait until the next included review is available.
You're only billed for reviews past your plan's rate limits ($0.25/file).

How can I continue?

After more reviews become available, a review can be triggered using the @coderabbitai review command as a PR comment. Alternatively, push new commits to this PR.

To avoid repeated limits, reduce automatic review volume by pausing incremental auto-reviews earlier, using label-based review opt-in, excluding WIP or generated PR titles, or requesting reviews manually when the PR is ready. If your team needs uninterrupted high-volume reviews, an organization admin can enable usage-based reviews.

How do review limits work?

CodeRabbit enforces per-developer PR review limits for each organization. Most developers receive the normal plan review availability.

For paid Pro and Pro+ PR reviews, CodeRabbit uses adaptive limits for sustained high-volume activity. When a developer's recent PR review activity reaches the 95th percentile or higher among CodeRabbit users, additional reviews become available more gradually as earlier reviews age out of the rolling window.

Please refer docs for additional details.

Review details
⚙️ Run configuration

Configuration used: defaults

Review profile: CHILL

Plan: Pro Plus

Run ID: 2cd99f37-dad8-4efe-813f-ceae28ebcfc1

📥 Commits

Reviewing files that changed from the base of the PR and between d505ef5 and 8e2bf3e.

📒 Files selected for processing (4)
  • docs/app/scripts/check_heading_outline.py
  • docs/app/tests/test_heading_outline.py
  • docs/app/xy_docs/demos/benchmark_charts.py
  • docs/components/modebars-and-interaction-controls.md

Comment @coderabbitai help to get the list of available commands.

@Alek99
Alek99 marked this pull request as ready for review July 31, 2026 03:58

@cubic-dev-ai cubic-dev-ai Bot 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.

All reported issues were addressed across 4 files

Reply with feedback, questions, or to request a fix.

Fix all with cubic | Re-trigger cubic

Comment thread docs/app/scripts/check_heading_outline.py Outdated
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Docs heading outline skips from H1 to H3 on two pages

1 participant