Skip to content

Conversation

@Earnwithalee7890
Copy link

What changed? Why?

This PR corrects heading hierarchy issues across Base Chain documentation to ensure proper semantic structure. The changes fix heading levels (h1, h2, h3, etc.) to follow a logical, sequential order without skipping levels, which improves both accessibility and SEO.

Files updated:

  • Base Chain documentation pages with heading hierarchy issues
  • All headings now follow proper sequential order (h1 → h2 → h3, etc.)
  • No heading levels are skipped in the document structure

Proper heading hierarchy provides:

  • Better SEO - Search engines use heading structure to understand content organization
  • Improved accessibility - Screen readers rely on heading hierarchy for navigation
  • Enhanced readability - Logical structure helps all users scan and understand content
  • Consistent documentation - Standardized structure across all pages

Notes to reviewers

  • Heading content remains unchanged; only heading levels have been adjusted
  • Each page maintains a single h1 (typically the page title in frontmatter)
  • Subsequent headings follow logical nesting without skipping levels
  • Changes follow documentation best practices and WCAG 2.1 guidelines
  • No functional changes to the documentation

How has it been tested?

  • Manually verified heading hierarchy on each updated page
  • Confirmed no heading levels are skipped (e.g., h2 → h4)
  • Validated that page outlines are logical and properly nested
  • Checked that documentation builds successfully
  • Reviewed table of contents generation to ensure proper structure
  • Tested screen reader navigation on updated pages

@cb-heimdall
Copy link
Collaborator

🟡 Heimdall Review Status

Requirement Status More Info
Reviews 🟡 0/2
Denominator calculation
Show calculation
1 if user is bot 0
1 if user is external 0
2 if repo is sensitive 0
From .codeflow.yml 1
Additional review requirements
Show calculation
Max 0
0
From CODEOWNERS 0
Global minimum 0
Max 1
1
1 if commit is unverified 1
Sum 2

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.

2 participants