-
Notifications
You must be signed in to change notification settings - Fork 4
Update Overlays documentation for issue #88. #101
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
base: main
Are you sure you want to change the base?
Conversation
Hey @kurapativyshnavi How is this PR different from #102? I will review this one for now :-) |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Can you please make the adjustments to the text.
The feel of the text is very AI generated now.
Please use shorter and less complicated sentences.
For most of our readers English is not their first language.
Also divide long paragraphs into shorter ones for readability.
docs/start/myths/overlays.md
Outdated
- add more resources from within the WP community. | ||
# Accessibility Overlays: A Comprehensive Overview | ||
|
||
### What are Accessibility Overlays? |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Change into an H2.
Please read Accessible heading structure that explains why.
docs/start/myths/overlays.md
Outdated
|
||
Accessibility overlays are third-party software widgets or plugins designed to be added to a website to address accessibility issues. Typically, these tools are marketed as a quick and inexpensive way to achieve legal compliance and make a website more accessible. They operate by injecting a layer of JavaScript code into a website, often appearing as a small, floating icon that, when activated, reveals a menu of options such as font adjustments, color contrast changes, or other visual settings. | ||
|
||
### The Distinction Between Overlays and Toolbars |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Change into an H2.
docs/start/myths/overlays.md
Outdated
|
||
While both accessibility overlays and user preference toolbars may offer similar features, their underlying functionality and purpose are fundamentally different. Understanding this distinction is crucial for effective web accessibility. | ||
|
||
* **Accessibility Overlays:** These are presented as a comprehensive solution to accessibility challenges. They are designed to act as a "fix" for a website's underlying code by attempting to automatically remediate accessibility issues on the fly. However, they frequently fail to correct fundamental problems with a site’s HTML, ARIA, or CSS. This approach can create new barriers for users of assistive technologies and often provides a false sense of compliance. An overlay is intended to fix the site for the user, but it cannot fix inaccessible source code. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Remove the list * (as this is not a list) :-)
docs/start/myths/overlays.md
Outdated
|
||
* **Accessibility Overlays:** These are presented as a comprehensive solution to accessibility challenges. They are designed to act as a "fix" for a website's underlying code by attempting to automatically remediate accessibility issues on the fly. However, they frequently fail to correct fundamental problems with a site’s HTML, ARIA, or CSS. This approach can create new barriers for users of assistive technologies and often provides a false sense of compliance. An overlay is intended to fix the site for the user, but it cannot fix inaccessible source code. | ||
|
||
* **User Preference Toolbars:** In contrast, toolbars are client-side applications that do not alter the website's original code. Their purpose is not to "fix" a site but to empower the end-user. They offer personal customization features, allowing individuals to modify their own browsing experience to suit their needs, such as adjusting text size or contrast. These tools are most effective when used on a website that is already built to be accessible, as they complement, rather than substitute for, proper accessibility practices. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Remove the list * (as this is not a list) :-)
docs/start/myths/overlays.md
Outdated
|
||
* **User Preference Toolbars:** In contrast, toolbars are client-side applications that do not alter the website's original code. Their purpose is not to "fix" a site but to empower the end-user. They offer personal customization features, allowing individuals to modify their own browsing experience to suit their needs, such as adjusting text size or contrast. These tools are most effective when used on a website that is already built to be accessible, as they complement, rather than substitute for, proper accessibility practices. | ||
|
||
### Additional Resources |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Change into an H2.
docs/start/myths/overlays.md
Outdated
#### The Overlays Fact Sheet | ||
|
||
A comprehensive, multi-lingual report detailing the issues and risks associated with accessibility overlays: | ||
* [overlayfactsheet.com](https://overlayfactsheet.com/en/) |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Remove the list * (as this is not a list) :-)
docs/start/myths/overlays.md
Outdated
#### Videos from Accessibility Experts | ||
|
||
* **"Overlays Underwhelm"** by Adrian Roselli: A detailed presentation on the shortcomings of overlays. | ||
* [https://www.youtube.com/live/RDkqJaBwgKU](https://www.youtube.com/live/RDkqJaBwgKU) |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Remove the list * (as this is not a list) :-)
Link "Overlays Underwhelm" and not the URL itself.
This makes the link text meaningful.
Proposed code
**[Overlays Underwhelm](https://www.youtube.com/live/RDkqJaBwgKU)** by Adrian Roselli: A detailed presentation on the shortcomings of overlays.
docs/start/myths/overlays.md
Outdated
* **"Overlays Underwhelm"** by Adrian Roselli: A detailed presentation on the shortcomings of overlays. | ||
* [https://www.youtube.com/live/RDkqJaBwgKU](https://www.youtube.com/live/RDkqJaBwgKU) | ||
|
||
* **"There is no spoon"** by Léonie Watson: This well-known talk discusses the importance of designing for people, not for technology, and the limitations of quick-fix solutions. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Same as previous
Remove the lists * (as this is not a list) :-)
Link There is no spoon and not the URL itself.
docs/start/myths/overlays.md
Outdated
* [https://www.youtube.com/watch?v=fyRxd072JrA](https://www.youtube.com/watch?v=fyRxd072JrA) | ||
(Note: The video you originally linked is about AI and accessibility, but this is Léonie Watson's celebrated talk on this topic.) | ||
|
||
#### Resources from the WordPress Community |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Change into an H3.
fix(docs): update overlays page with simplified text, video embeds, and alert
Hi @kurapativyshnavi I really appreciate your work on the search option, please concider using your time contributing with code. |
Completes all tasks listed in issue #88 by adding the "Overlays" documentation content.