fix(accessibility): clean headings structure in rule sections descriptions#1112
Merged
bagelbits merged 2 commits into5e-bits:mainfrom May 5, 2026
Conversation
…eadings structure
bagelbits
approved these changes
May 5, 2026
bagelbits
pushed a commit
that referenced
this pull request
May 5, 2026
🤖 I have created a release *beep* *boop* --- ## [5.5.1](v5.5.0...v5.5.1) (2026-05-05) ### Bug Fixes * **accessibility:** clean headings structure in rule sections descriptions ([#1112](#1112)) ([828257c](828257c)) --- This PR was generated with [Release Please](https://github.com/googleapis/release-please). See [documentation](https://github.com/googleapis/release-please#release-please). Co-authored-by: 5e-bits-deploy-bot[bot] <209387221+5e-bits-deploy-bot[bot]@users.noreply.github.com>
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 does this do?
In
5e-SRD-Rule-Sections.jsondescription fields (desc), some headings levels are increasing more than 1 level at a time which creates an invalid headings hierarchy and can cause accessibility issues.This PR realign problematic headings :
The changes are hard to spot due to the Markdown being on one singel line but basically it's some "####" being replaced with "###" and so on.
How was it tested?
It was tested with Axe Devtools extension and fixes the following rule: https://dequeuniversity.com/rules/axe/4.10/heading-order.
npm run testpasses.Is there a Github issue this is resolving?
No.
Did you update the docs in the API? Please link an associated PR if applicable.
No.