Skip to content

📚 Documentation: Tutorials page skips from <h2> to <h4> [a11y][TheA11y100] #280

@GrahamTheDevRel

Description

@GrahamTheDevRel

💭 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?

Metadata

Metadata

Assignees

Labels

documentationImprovements or additions to documentationgood first issueGood for newcomers

Type

No type

Projects

No projects

Milestone

No milestone

Relationships

None yet

Development

No branches or pull requests

Issue actions