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

🛠 Repo: CHANGELOG.md accessibility issues: headings #5082

Closed
5 tasks done
JoshuaKGoldberg opened this issue Jan 18, 2024 · 0 comments · Fixed by #5083
Closed
5 tasks done

🛠 Repo: CHANGELOG.md accessibility issues: headings #5082

JoshuaKGoldberg opened this issue Jan 18, 2024 · 0 comments · Fixed by #5083
Labels
area: repository tooling concerning ease of contribution status: accepting prs Mocha can use your help with this one! type: bug a defect, confirmed by a maintainer

Comments

@JoshuaKGoldberg
Copy link
Member

Tooling Suggestion Checklist

Overview

Right now the CHANGELOG.md file is manually edited to have many # h1s. Although crawlers such as Google's can handle them, it's generally accessibility best practice not to in straightforward pages such as a changelog (e.g. https://www.a11yproject.com/posts/how-to-accessible-heading-structure/#one-h1). Instead we should have a single # Changelog h1 followed by h2s for each entry.

Additional Info

No response

@JoshuaKGoldberg JoshuaKGoldberg added area: repository tooling concerning ease of contribution type: bug a defect, confirmed by a maintainer status: accepting prs Mocha can use your help with this one! labels Jan 18, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
area: repository tooling concerning ease of contribution status: accepting prs Mocha can use your help with this one! type: bug a defect, confirmed by a maintainer
Projects
None yet
Development

Successfully merging a pull request may close this issue.

1 participant