-
Notifications
You must be signed in to change notification settings - Fork 189
Update README.md
to be clearer.
#404
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
base: develop
Are you sure you want to change the base?
Update README.md
to be clearer.
#404
Conversation
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
#rucellmai61
This review is not justified unless more details can be provided
My experience is that this approach to using tables for navigation would fail an accessibility review. The new design is an improvement for many users but doesn't interact well with some common assistive technology. For example, when a screen reader is being used, and the user navigates through this:
with the tab key (which, of course, only goes to focusable links and thus always remains in the second column), the spoken word "View" is used to announce each of the four links. It's harder to pick the desired one from four identical announcements. There are other options but, in general, the user would either have to remember a row number, or remember what was announced when they were in a different cell. Also (less important), the user would hear "table with 4 rows and 2 columns" and this is a bit complex for a situation where a list can be used. GitHub .md files can't be used to satisfy all aspects of accessibility, but I feel that it would be better to replace all tables with approaches similar to:
|
Thanks, that's great feedback! I hadn't considered the impact of the table-based approach on screen reader accessibility and that's absolutely an oversight on my part. I really appreciate it, and will update the PR to replace the tables. |
This amends the `README.md` file to be clearer to navigate. This is achieved in several ways: - All links are now hyperlinks on explanatory text, instead of bare URLs. - Where appropriate, information has been gathered into tables. - How to participate in the QWG and contribute in the repository has been spelled out explicitly. - The distinction between the "production" and "development" versions of the format have been clearer by being split into distinct sections. Signed-off-by: Andrew Lilley Brinker <[email protected]>
262dc3e
to
230548a
Compare
@ElectricNroff, I've made the changes you suggested to remove the tables. Thanks again! |
Note to self, I need to add Dave Waltermire to the list of chairs in the README. |
View the rendered
README.md
hereThis amends the
README.md
file to be clearer to navigate. This is achieved in several ways: