Redocly / Redocly/redoc

Accessibility: skipped heading levels (h2 -> h5)

Open
#2,408 0 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

a11y Type: Bug
Dominant language
TypeScript
Stars
25.9k
Forks
2.4k
Avg merge
13h 10m
Merged PRs (30d)
4

Description

Describe the bug

  1. Go to Redocly Demo
  2. Run WAVE Chrome Extension
  3. Observe heading levels are skipped, h2 -> h5 (see Screenshots)

Expected behavior
Heading levels should not be skipped.

Screenshots
Screenshot of WAVE run on Redocly demo with heading levels highlighted. Heading order is h2 -> h5

Additional context
Deque University - Heading levels should only increase by one

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Start by reproducing the issue on the linked Redocly Demo with the WAVE Chrome Extension and confirm the h2-to-h5 jump. Locate the heading-rendering code from there, then verify that heading levels increase one at a time and rerun the accessibility check to confirm no skipped levels remain.

Written by the indexing model from the issue text.

Assessment

Tech stack
typescript
Domain
accessibility, frontend
Issue type
Bug
Difficulty
3/5
Estimated time
1-2 days
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
45/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.