Opened 8 weeks ago

Closed 6 weeks ago

Last modified 6 weeks ago

#35863 closed Cleanup/optimization (fixed)

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: Ready for checkin
Has patch: yes 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 (7)

comment:1 by Sarah Sanger, 8 weeks ago

Owner: set to Sarah Sanger
Status: newassigned

comment:2 by Sarah Sanger, 8 weeks ago

Owner: Sarah Sanger removed

comment:3 by Thibaud Colas, 8 weeks ago

Cc: Thibaud Colas added
Owner: set to Sarah Sanger
Triage Stage: UnreviewedAccepted
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:

Information, structure, and relationships conveyed through presentation can be programmatically determined or are available in text.

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.

comment:4 by Sarah Boyce, 6 weeks ago

Has patch: set
Patch needs improvement: set

comment:5 by Sarah Boyce, 6 weeks ago

Patch needs improvement: unset
Triage Stage: AcceptedReady for checkin

comment:6 by Sarah Boyce <42296566+sarahboyce@…>, 6 weeks ago

Resolution: fixed
Status: assignedclosed

In c4c07622:

Fixed #35863 -- Replaced bold text with heading level 3 in new contributors docs.

This improves accessibility for screen reader users, see WCAG SC 1.3.1 Info and Relationships:
https://www.w3.org/WAI/WCAG22/Understanding/info-and-relationships.html

comment:7 by Sarah Boyce <42296566+sarahboyce@…>, 6 weeks ago

In 08c0c421:

[5.1.x] Fixed #35863 -- Replaced bold text with heading level 3 in new contributors docs.

This improves accessibility for screen reader users, see WCAG SC 1.3.1 Info and Relationships:
https://www.w3.org/WAI/WCAG22/Understanding/info-and-relationships.html

Backport of c4c076223eb73553d3bc8fbc11be2c529d9aea6b from main.

Note: See TracTickets for help on using tickets.
Back to Top