EES-5554 Fix accessibility issues in public API docs #5589
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
amyb-hiveit
approved these changes
Feb 6, 2025
There was a problem hiding this comment.
I can't get this running locally to fully check, but I think this all looks ok.
I did find another issue that hasn't been raised, though I don't know if it's something we can fix or if it's outside of our control - the heading level on search results skips from h1 to h3:
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
This PR fixes various accessibility issues that have been highlighted by @N-moh
aria-label/aria-labelledbyattributes for parameter tablesword-break)Additionally, I've made some more tweaks whilst in the area:
Screenshots
New header:
New TOC:
New parameter tables: