Opened 35 hours ago
Last modified 33 hours ago
#35863 assigned Cleanup/optimization
Advice for new contributors documentation should be structured with headings - Accessibility
Reported by: | Sarah Sanger | Owned by: | Sarah Sanger |
---|---|---|---|
Component: | Documentation | Version: | 5.1 |
Severity: | Normal | Keywords: | Accessibility Documentation Contributing |
Cc: | Thibaud Colas | Triage Stage: | Accepted |
Has patch: | no | Needs documentation: | no |
Needs tests: | no | Patch needs improvement: | no |
Easy pickings: | yes | UI/UX: | no |
Description
The advice for new contributors documentation page is misusing bold text within list items as headings. This is a common accessibility issue. Though visually the text stands out, for screen reader users all of those guidelines are one big unstructured list. They will get no indication of what’s a heading and what’s the guideline’s contents.
For all users, it would also be very neat to be able to link straight to one of those guidelines. So – we need to replace the bold text with semantic headings (heading level 3)
Change History (3)
comment:1 by , 35 hours ago
Owner: | set to |
---|---|
Status: | new → assigned |
comment:2 by , 35 hours ago
Owner: | removed |
---|
comment:3 by , 33 hours ago
Cc: | added |
---|---|
Owner: | set to |
Triage Stage: | Unreviewed → Accepted |
UI/UX: | unset |
Thank you for the report Sarah! The current pattern is a pretty clear failure of WCAG SC 1.3.1 Info and Relationships:
For reference, we also did a similar change in PR #17549. Note for the page you mention there seems to be two lists with this issue; under First steps and Guidelines.