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: Tutorials page skips from <h2> to <h4> [a11y][TheA11y100] #280

Closed
2 tasks done
GrahamTheDevRel opened this issue Oct 25, 2023 · 2 comments · Fixed by #287
Closed
2 tasks done
Assignees
Labels
documentation Improvements or additions to documentation good first issue Good for newcomers

Comments

@GrahamTheDevRel
Copy link

💭 Description

Issue

On the tutorials page the heading levels skip from <h2> to <h4>.

Headings Map showing skipped heading levels from h2 to 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

Two options here: first is to change the <h4> on each card to a <h3>.

However there is also a <h2> called "client" which is not currently needed / is redundant. A better option may be to remove this <h2> and promote the current cards' <h4>s to <h2>s as this will be a more logical structure for the page.

screenshot of current page with a heading level 2 called "client" and then heading level 4s for each item

Relevant Success Criterion WCAG

Info and Relationships in WCAG
Technique using heading levels

Additional Notes

Good first issue, but needs input from Appwrite to which solution they would prefer.

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
@bL34cHig0
Copy link

May I be assigned to this please?

@CBID2
Copy link
Contributor

CBID2 commented Oct 25, 2023

May I be assigned to this please?
Lol, I was just about to volunteer. :) Can I work on this? :) Accessibility is my jam and I love @GrahamTheDevRel! :) Hehe, that rhymed! :)

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.

5 participants