minor: Fix heading levels on docs homepage#1448
Merged
Merged
Conversation
a11y guidelines state that heading levels should increment by one level at a time (e.g. `<h4>` must be preceded by an `<h3>`) We were using `<h4>` for the first two headings on the docs homepage, which violates that rule. I suspect this was to keep these headings out of the sidebar or for stylistic reasons (smaller font size). I’ve switched back to `<h2>` to fix this a11y issue (it impacts Lighthouse scores amongst other things), and used a literal `<h2>` tag for the first mini section to avoid that showing up in the table of contents.
✅ Deploy Preview for astro-docs-2 ready!
To edit notification comments on pull requests, go to your Netlify site settings. |
Member
|
LGTM! 💜 |
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
2 participants
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 kind of changes does this PR include?
Description
a11y guidelines state that heading levels should increment by one level at a time (e.g.
<h4>must be preceded by an<h3>) We were using<h4>for the first two headings on the docs homepage, which violates that rule. I suspect this was to keep these headings out of the sidebar or for stylistic reasons (smaller font size).I’ve switched back to
<h2>to fix this a11y issue (it impacts Lighthouse scores amongst other things), and used a literal<h2>tag for the first mini section to avoid that showing up in the table of contents.