docs: prevent redundant first headings - #1967
Merged
Merged
Conversation
Contributor
|
Preview deployment for your docs. Learn more about Mintlify Previews.
💡 Tip: Enable Automations to automatically generate PRs for you. |
Collaborator
✅ Heimdall Review Status
|
youssefea
force-pushed
the
toshi/check-header-redundancy-styling
branch
from
September 14, 2026 15:59
0f17d15 to
5c11f3b
Compare
youssefea
force-pushed
the
toshi/check-header-redundancy-styling
branch
from
September 14, 2026 16:01
5c11f3b to
c13bad3
Compare
Co-authored-by: Codex <codex-noreply@coinbase.com>
youssefea
force-pushed
the
toshi/check-header-redundancy-styling
branch
from
September 14, 2026 16:14
c13bad3 to
a2a4215
Compare
soheimam
approved these changes
Sep 14, 2026
ericbrown99
approved these changes
Sep 14, 2026
roethke
self-requested a review
September 14, 2026 17:09
roethke
approved these changes
Sep 14, 2026
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
What changed? Why?
heading/redundant-page-titlerule to the MDX linter used by Docs Style / Conformance.&/and, and strip conservative introductory phrases such as “What Is” and “Introduction to” before comparing the first body heading with the frontmatter title.scripts/lint-mdx.jsto the IA CI Configuration protected paths so future guardrail changes require three Writer approvals.Notes to reviewers
Mintlify already renders the frontmatter title as the page H1. The new rule prevents authors from immediately rendering the same title again as the first H2.
The spacing selectors use the stable
#contentID. They tighten the transition into all MDX content, with an additional reset when the first element is an H2:In a local Mintlify preview, both description-to-prose and description-to-first-heading spacing now measure 36px. Prose decreased from 52px to 36px, and a direct first H2 decreased from 84px to 36px. Headings that follow body content and later headings are unchanged.
How has it been tested?
npm test— 85/85 tests pass.node scripts/lint-mdx.js all --format=github— 313 published MDX pages checked with 0 errors.git diff --checkScreenshots
Validated in a local Mintlify preview. The visible gap is now 36px for both prose and a first heading, and the duplicate headings no longer render on the three affected pages.