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

README: avoid _here_ links; ack readthedocs #2222

Merged
merged 1 commit into from
Aug 28, 2017
Merged

Conversation

dckc
Copy link
Contributor

@dckc dckc commented Aug 28, 2017

Motivation and Context

Screen reader users often navigate from link to link, skipping the text in between

Implication 1: Links should make sense out of context. Phrases such as "click here," "more," "click for details," and so on are ambiguous when read out of context. -- http://webaim.org/techniques/hypertext/

https://www.w3.org/TR/WCAG10-HTML-TECHS/#link-text

Have you tested this? If so, how?

I expect tweaking README text has no testing impact.

> Screen reader users often navigate from link to link, skipping the text in between
>
> Implication 1: Links should make sense out of context. Phrases such as "click here," "more," "click for details," and so on are ambiguous when read out of context. -- http://webaim.org/techniques/hypertext/

https://www.w3.org/TR/WCAG10-HTML-TECHS/#link-text
@Tarrasch
Copy link
Contributor

Wow, I really love how you pay attention to detail and users who use screen readers here!

@Tarrasch Tarrasch merged commit 102211c into spotify:master Aug 28, 2017
@dckc
Copy link
Contributor Author

dckc commented Aug 28, 2017

Thanks.

I've been having fun with luigi for a little while now... https://github.com/kumc-bmi/grouse/tree/master/etl_i2b2

I use that link from the README to get to the documentation pretty regularly, and it bugged me a little bit each time... and github makes it so easy to fix... so today I did.

@dckc dckc deleted the patch-1 branch August 28, 2017 20:23
This was referenced Jun 29, 2022
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants