EoinShaughnessy
commented
2 years ago @kellylee-gds I asked the Accessibility Team whether there needs to be content under headings. They said:
It’s not an accessibility fail, but it is a preference for some screen reader users.
Basically, if there’s no content between headings, some users are concerned there is something there that they can’t access
so spend a while trying to get their software to access the ‘thing’ between headings
but when there is no ‘thing’ and it just leads onto another heading, this could cause confusion and waste time
stevenjmesser
colinrotherham
What
Add explanatory/introductory text under headings in Sass API Reference. Possibly also revise some headings to make them more meaningful to users.
Why
Because of how the Sass API Reference is generated, no explanatory text displays under its headings. This means we are not telling users what the different sections can help them do.
There may also be an impact on accessibility - using headings that do not appropriately describe their related content is a failure of WCAG 2.4.6: Headings and Labels.
For example, would anyone coming to this content for the first time necessarily know what we mean by 'Assets'/ 'Settings' here? 👇🏻 Or even what the 'Sass API reference section' is for, generally?
Who needs to know about this
Laurence, Eoin
Done when
*However, the bulk of this work will be in the govuk-frontend-docs repo.