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

Axe accessibility issues on Svelte docs #5678

Closed
1 of 8 tasks
geoffrich opened this issue Nov 13, 2020 · 6 comments
Closed
1 of 8 tasks

Axe accessibility issues on Svelte docs #5678

geoffrich opened this issue Nov 13, 2020 · 6 comments

Comments

@geoffrich
Copy link
Member

geoffrich commented Nov 13, 2020

Describe the bug
When running the axe accessibility checker on the docs, it identifies multiple accessibility issues:

<a href="#aria-hidden" aria-label="Permalink for aria-hidden (state)" title="Permalink for aria-hidden (state)" property="url">
  <span property="title" content="aria-hidden (state)">§</span>
</a>

To Reproduce

  1. Install the axe Chrome extension (also available for other browsers)
  2. Go to https://svelte.dev/docs
  3. Go to the Axe tab in dev tools and run the analysis

Expected behavior
There should be 0 Axe violations.

Severity
These issues make navigating the docs when using a screen reader more difficult. The Svelte tutorial calls out how it helps you write accessible markup -- we should set a good example by holding the docs to a high accessibility standard.

Additional context
I know this is quite a few issues in one 😅. We could split this into multiple issues if desired. However, some are closely related (e.g. everything to do with the permalinks) and some are small fixes.

@geoffrich
Copy link
Member Author

I'd love to work on a PR for this, if that's okay.

@antony
Copy link
Member

antony commented Nov 13, 2020

@geoffrich Feel free - the better accessible the docs are, the... better

@geoffrich
Copy link
Member Author

With the syntax highlighting PR merged, the color contrast violation count is down to 228 from 2018.

@geoffrich
Copy link
Member Author

Most of the remaining color contrast violations are on links. I opened a corresponding issue in site-kit since that's where the styles are coming from. Not sure who would be involved in choosing or updating a core theme color like that.

@stale
Copy link

stale bot commented Jun 26, 2021

This issue has been automatically marked as stale because it has not had recent activity. It will be closed if no further activity occurs. Thank you for your contributions.

@stale stale bot added the stale-bot label Jun 26, 2021
@geoffrich
Copy link
Member Author

I'll go ahead and close this since svelte.dev will be migrating to SvelteKit soon. If still relevant, I'll re-create the issue in the sites repo.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

No branches or pull requests

2 participants