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

Add accessibility section to docs #4119

Closed
jfennell-techempower opened this issue Dec 16, 2019 · 4 comments
Closed

Add accessibility section to docs #4119

jfennell-techempower opened this issue Dec 16, 2019 · 4 comments

Comments

@jfennell-techempower
Copy link

Is your feature request related to a problem? Please describe.
The fact that Svelte helps developers write more accessible code by default is a feature that sets Svelte apart from most other frontend frameworks I've used, in which accessibility is generally treated as an afterthought. From what I can tell, there is nothing in the docs highlighting Svelte's emphasis on accessibility in-depth.

Describe the solution you'd like
I see that there is this open issue, #820 showing some of the checks that are implemented, as well as future checks that will be added.
Add a page to the documentation highlighting the emphasis Svelte places on accessibility, with an up-to-date list of a11y checks the compiler makes. That page would ideally mention the ability to suppress the warnings - to make clear to users that the a11y checks won't slow them down in cases where they need to rapidly prototype.

Describe alternatives you've considered
I don't really see any alternatives - public framework features are generally documented through documentation.

How important is this feature to you?
This is very important to me. I wish to make services as accessible as possible when working on personal projects, and have worked on client projects where accessibility is a first-class feature of the application. In a discussion where a client asks about accessibility in choosing an application stack, it would be great to be able to point them to official Svelte documentation, to quickly make the case that Svelte is a good choice for building WCAG-compliant apps.

@Wolfr
Copy link
Contributor

Wolfr commented Jul 21, 2020

I would also appreciate a focus on accessibility.

I would suggest adding a question to the FAQ, that is about whether Svelte is accessible. That seems to be the most logical place to put such information. In the answer we could refer to Svelte as a compiler having the ability to help you write more accessible code, for instance by checking for missing alt tags.

What do you think @jfennell-techempower ?

@MaiHistoryCompanyLimited

This comment has been minimized.

@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.

@dummdidumm
Copy link
Member

This exists now: https://svelte.dev/docs#Accessibility_warnings

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

7 participants