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

Add intro between H1 and H2 to pages missing it #465

Open
2 tasks
romaricpascal opened this issue Sep 27, 2024 · 1 comment
Open
2 tasks

Add intro between H1 and H2 to pages missing it #465

romaricpascal opened this issue Sep 27, 2024 · 1 comment
Labels
documentation Improvements or additions to documentation

Comments

@romaricpascal
Copy link
Member

romaricpascal commented Sep 27, 2024

What

Add some introductory content to pages having nothing between their H1 and H2:

Why

For consistency with the other pages, but also because the lack of content between headings may look like (sound, more accurately) content is missing for assistive technology when the page is being read out.

Who needs to know about this

Tech writers, Developers

Done when

@romaricpascal romaricpascal added awaiting triage Needs triaging by team documentation Improvements or additions to documentation and removed awaiting triage Needs triaging by team labels Sep 27, 2024
@calvin-lau-sig7
Copy link
Contributor

calvin-lau-sig7 commented Sep 27, 2024

Thanks for the heads-up. Yeah, I think this makes sense to do – I vaguely remember that this isn't a serious accessibility issue, but more good content practice so users can be sure they're on the right page.

I think having good content here also helps with generating good 'page descriptions' that get shown on search results, page previews in social media, etc.

Even something basic and obvious would work.

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
Projects
None yet
Development

No branches or pull requests

2 participants