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

False negative? Link with <code> inside #170

Open
eksperimental opened this issue Aug 21, 2020 · 0 comments
Open

False negative? Link with <code> inside #170

eksperimental opened this issue Aug 21, 2020 · 0 comments

Comments

@eksperimental
Copy link

I think it is valid, since there is text (well code) that can be read by the screen-reader

**Link text is unclear**
The text "--/2" is unclear without context and may be confusing to screen readers. Consider rearranging the <a></a> tags or including special screen reader text.
Relevant code:
<a href="#--/2" class="no-underline"><code class="inline">--/2</code></a>

Am I wrong?

eksperimental added a commit to eksperimental-forks/ex_doc that referenced this issue Aug 23, 2020
Most of the suggestions have been done by https://github.com/Khan/tota11y
It passes all the tests, with the exception of one test which I consider is not valid,
and it has been reported here: jdan/tota11y#170

Changes include:
- Font colors have been updated to have enough contrast in day-mode and night-mode.

- The HTML structure has been updated to it only contain the title inside the heading tags (h1, h2), otherwise it will look weird in screen readers.

- The h1 title of the project in the content section has been changed so it looks like:
    Some module <small class="app-vsn">(ProjectName v0.0.1)</small>
	instead of:
		<small class="app-vsn">ProjectName v0.0.1</small> Some module

- Search box makes use of ARIA attributes

- Project name in the sidebar is not a heading anymore.

- Less have been simplified in some parts where code was duplicated in the night mode.
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

No branches or pull requests

1 participant