docs(README): improve the accessibility of README #2726
Conversation
Add accessibility features based on: https://github.blog/2023-10-26-5-tips-for-making-your-github-profile-page-accessible/
github-actions
bot
added
the
S-conventions-not-followed
| @@ -145,16 +139,14 @@ analytics, and operations end-to-end: | |||
| - Custom dashboards with deep analytics, alerts, and reporting | |||
| - Expert team to consult and improve business metrics | |||
|
|
|||
| You can [try the hosted version in our sandbox][dashboard]. | |||
| You can [try the hosted version in our sandbox](). <!-- needs a link here! --> | |||
There was a problem hiding this comment.
We used reference-style links to avoid duplication of links and make the source content more readable. Regardless, I couldn't find any information on the linked article that discourage the use of reference-style links. Any specific reason for changing all of them to inline links?
There was a problem hiding this comment.
The reason for inline links as when people who use accessibility settings, the audio is read out as it is. Thus the person hearing it can't just stop and "scroll" to the bottom of the page to see where/what it is linking it. Having the link directly attached to where it's referenced helps these people quickly navigate. It's up to you thought 😉 let me know what you'd like to do.
There was a problem hiding this comment.
Correct me if I'm wrong, but the guidelines on the linked blog post suggests including alt text with links/images so that the rendered markdown is easy to navigate through. Keeping the links inline or in reference-style in markdown source code does not affect the rendered content, so we should be good to use the reference-style links?
What do you think, @VedantKhairnar?
SanchithHegde
added
C-doc
SanchithHegde
changed the title
github-actions
bot
removed
the
S-conventions-not-followed
Type of Change
Description
Add accessibility features based on: https://github.blog/2023-10-26-5-tips-for-making-your-github-profile-page-accessible/
Additional Changes
Motivation and Context
Accessibility is important to ensure EVERYONE can use the repo regardless of their own physical or mental circumstances.
How did you test it?
NA
Checklist
cargo +nightly fmt --allcargo clippy