Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

📚 Documentation: Heading levels in menu should be h2s [a11y][TheA11y100] #279

Closed
2 tasks done
GrahamTheDevRel opened this issue Oct 25, 2023 · 5 comments · Fixed by #302
Closed
2 tasks done

📚 Documentation: Heading levels in menu should be h2s [a11y][TheA11y100] #279

GrahamTheDevRel opened this issue Oct 25, 2023 · 5 comments · Fixed by #302
Assignees
Labels
documentation Improvements or additions to documentation good first issue Good for newcomers

Comments

@GrahamTheDevRel
Copy link

GrahamTheDevRel commented Oct 25, 2023

Issue

All headings in the left navigation should be changed to <h2>s.

Ideally these would come after an <h1> but due to current page design it is acceptable compromise to have them come before as a quick fix for now.

side nav with a heading highlighted, console showing elements pane indicating it is a <h4>

Why it matters

People using assistive technology rely on proper headings structure to navigate effectively. By skipping levels people can get lost or miss entire sections of content using assistive tech.

Suggested fix

All headings in the left navigation should be changed to <h2>s.

Relevant Success Criterion WCAG

Info and Relationships in WCAG
Technique using heading levels

Additional Notes

Ideal First issue.

Found on stream on 2023-10-25

👀 Have you spent some time to check if this issue has been raised before?

  • I checked and didn't find similar issue

🏢 Have you read the Code of Conduct?

@GrahamTheDevRel GrahamTheDevRel added the documentation Improvements or additions to documentation label Oct 25, 2023
@Arindam200
Copy link
Contributor

I would love to work on this! Can you please assign me?

@CBID2
Copy link
Contributor

CBID2 commented Oct 25, 2023

I would love to work on this issue :)

@uttampun44
Copy link

I would like to fix the issue. Assign me 

@TorstenDittmann TorstenDittmann added the good first issue Good for newcomers label Oct 26, 2023
@TGlide
Copy link
Contributor

TGlide commented Oct 30, 2023

@Arindam200 assigned it to you 😄

@Arindam200
Copy link
Contributor

@Arindam200 assigned it to you 😄

Thanks! I have made the PR

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation good first issue Good for newcomers
Projects
None yet
Development

Successfully merging a pull request may close this issue.

6 participants