zowe / docs-site

Documentation for the Zowe project
https://docs.zowe.org/
Creative Commons Attribution 4.0 International
69 stars 134 forks source link

Improve Zowe documentation accessibility #1643

Open nannanli opened 3 years ago

nannanli commented 3 years ago

Write the documentation with accessibility in mind. This is also a feedback in the Zowe community survey: more attention to accessibility, current docs are almost unusable for visually impaired users. Spend some time with it blindfolded at a Mac with VoiceOver enabled.

To do that, need to do the following:

nannanli commented 3 years ago

Here are some accessibility resources provided by Jakub (thanks @balhar-jakub !)

balhar-jakub commented 3 years ago

Thanks, I would just mention that the book isn't the best resource for exactly what you are trying to solve. The WCAG is more important resource.

The book is more focused on how to adapt what we know around accessibility to people with dyslexia.

nannanli commented 2 years ago

https://marketplace.visualstudio.com/items?itemName=DavidAnson.vscode-markdownlint is useful for style checking including a check of 2 common accessibility issues.