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

Update content for accessibility chapter #359

Open
wants to merge 2 commits into
base: main
Choose a base branch
from

Conversation

drmenzelit
Copy link
Contributor

@drmenzelit drmenzelit commented Jan 6, 2025

User description

Added a list of links in "Further Readings" and added the contact mail for issues


PR Type

Documentation


Description

  • Added comprehensive resources to the "Further Reading" section.

  • Included a contact email for reporting accessibility issues.

  • Removed placeholder text and TODO notes from the documentation.

  • Enhanced accessibility documentation with categorized links and tools.


Changes walkthrough 📝

Relevant files
Documentation
further-reading.md
Added comprehensive accessibility resources and tools.     

docs/accessibility/further-reading.md

  • Added categorized accessibility resources and tools.
  • Included links to blogs, courses, and checklists.
  • Removed placeholder text and TODO notes.
  • Enhanced content for better usability and completeness.
  • +42/-1   
    reporting-issues.md
    Added contact email for accessibility issue reporting.     

    docs/accessibility/reporting-issues.md

  • Added contact email for reporting accessibility issues.
  • Removed placeholder text and TODO notes.
  • Clarified reporting instructions for accessibility issues.
  • +1/-6     

    💡 PR-Agent usage: Comment /help "your question" on any pull request to receive relevant information

    Copy link
    Contributor

    qodo-merge-pro bot commented Jan 6, 2025

    Qodo Merge was enabled for this repository. To continue using it, please link your Git account with your Qodo account here.

    PR Reviewer Guide 🔍

    Here are some key observations to aid the review process:

    ⏱️ Estimated effort to review: 1 🔵⚪⚪⚪⚪
    🧪 No relevant tests
    🔒 No security concerns identified
    ⚡ Recommended focus areas for review

    Link Validation

    External links should be validated to ensure they are accessible and point to the correct resources. Some links may become outdated or change over time.

    - [UN Convention on the Rights of Persons with Disabilities](https://www.un.org/development/desa/disabilities/convention-on-the-rights-of-persons-with-disabilities/article-9-accessibility.html)
    - [Accessibility Fundamentals](https://www.w3.org/WAI/fundamentals)
    - [How to meet WCAG](https://www.w3.org/WAI/WCAG22/quickref/?versions=2.2)
    - [Inclusive Design Principles](https://inclusivedesignprinciples.info/)
    - [Accessibility Myths](https://a11ymyths.com/)
    
    ## Blogs
    - [Sara Soueidan](https://www.sarasoueidan.com/blog/)
    - [Eric Eggert](https://yatil.net/blog)
    
    ## Alternative text for images
    - [Writing Alt Text for Data Visualization](https://medium.com/nightingale/writing-alt-text-for-data-visualization-2a218ef43f81)
    - [Write helpful Alt Text to describe images](https://accessibility.huit.harvard.edu/describe-content-images)
    - [How to Write Alt Text for Images: Best Practices & Examples](https://kdesign.co/blog/how-to-write-alt-text/)
    - [Are you making these five mistakes when writing alt text?](https://www.a11yproject.com/posts/are-you-making-these-five-mistakes-when-writing-alt-text/)
    
    ## Browser Tools
    - Lighthouse (included Chrome)
    - [Wave](https://wave.webaim.org/)
    - [axe DevTools](https://www.deque.com/axe/devtools/)
    - [ANDI](https://www.ssa.gov/accessibility/andi/help/install.html)
    - [Landmarks](http://matatk.agrip.org.uk/landmarks/)
    - [IBM Equal Access Accessibility Checker](https://www.ibm.com/able/toolkit/tools/#develop)
    
    ## Screenreader
    - [NDVA (Windows)](https://www.nvaccess.org/)
    - VoiceOver (MacOS)
    - [Setting up a screen reader testing environment on your computer](https://www.sarasoueidan.com/blog/testing-environment-setup/)
    
    ## Checklisten & Co.
    - [The A11y Project](https://www.a11yproject.com/checklist/)
    - [Webflow](https://webflow.com/accessibility/checklist)
    - [Deque University](https://dequeuniversity.com/checklists/web/)
    - [IAAP](https://www.accessibilityassociation.org/s/certification)
    
    ## Courses
    - [Practical Accessibility - Sara Soueidan](https://practical-accessibility.today/)
    

    Copy link
    Contributor

    qodo-merge-pro bot commented Jan 6, 2025

    Qodo Merge was enabled for this repository. To continue using it, please link your Git account with your Qodo account here.

    PR Code Suggestions ✨

    Explore these optional code suggestions:

    CategorySuggestion                                                                                                                                    Score
    General
    Enhance issue reporting guidelines with specific instructions and expectations

    Add more details about the issue reporting process, including expected response time
    and what information to include in the report.

    docs/accessibility/reporting-issues.md [6]

    -You can report accessibility issues in the CMS (using the standard Cassiopeia template) sending us an email to: [[email protected]](mailto:[email protected])
    +You can report accessibility issues in the CMS (using the standard Cassiopeia template) by sending an email to: [[email protected]](mailto:[email protected])
     
    +When reporting an issue, please include:
    +- A clear description of the accessibility problem
    +- Steps to reproduce the issue
    +- The browser and assistive technology you're using
    +- Screenshots or recordings if applicable
    +
    +We aim to respond to all accessibility reports within 2 business days.
    +
    • Apply this suggestion
    Suggestion importance[1-10]: 9

    Why: The suggestion significantly improves the issue reporting process by adding crucial details about required information and setting clear expectations for response time, making it more effective for both users and maintainers.

    9
    ✅ Remove outdated TODO notice since the page is now complete with comprehensive resources
    Suggestion Impact:The TODO caution block was removed from the document as suggested

    code diff:

    -:::caution TODO
    -
    -This page is unfinished, please use the **Edit this Page** link at the bottom of this page to help make it more useful.
    -
    -:::

    Remove the TODO caution block since the page is no longer unfinished and now
    contains comprehensive accessibility resources.

    docs/accessibility/further-reading.md [8-12]

    -:::caution TODO
     
    -This page is unfinished, please use the **Edit this Page** link at the bottom of this page to help make it more useful.
     
    -:::
    -
    • Apply this suggestion
    Suggestion importance[1-10]: 8

    Why: The TODO notice is now obsolete since the page has been populated with extensive accessibility resources. Removing it would improve document clarity and professionalism.

    8
    Add descriptive context to resource links to improve user understanding and navigation

    Add brief descriptions for each resource to help users understand what they'll find
    before clicking the links.

    docs/accessibility/further-reading.md [16-17]

     ## General
     
    -- [UN Convention on the Rights of Persons with Disabilities](https://www.un.org/development/desa/disabilities/convention-on-the-rights-of-persons-with-disabilities/article-9-accessibility.html)
    -- [Accessibility Fundamentals](https://www.w3.org/WAI/fundamentals)
    +- [UN Convention on the Rights of Persons with Disabilities](https://www.un.org/development/desa/disabilities/convention-on-the-rights-of-persons-with-disabilities/article-9-accessibility.html) - International treaty defining accessibility rights and standards
    +- [Accessibility Fundamentals](https://www.w3.org/WAI/fundamentals) - W3C's essential guide to web accessibility principles
    • Apply this suggestion
    Suggestion importance[1-10]: 7

    Why: Adding brief descriptions to links would significantly improve user experience by helping readers understand the content before clicking, making the resource list more useful and efficient to navigate.

    7

    @HLeithner
    Copy link
    Member

    @drmenzelit I did some small syntax updates and added some url, I also removed the paid course because it looked like hidden advertisement compared to all other links. Hope the changes are ok for you.

    About the external Links (open in new browser), if you like to mark external links as external I think we should handel this with CSS?

    @drmenzelit
    Copy link
    Contributor Author

    @HLeithner
    Best practice is to not open links on new tabs ... if new tabs then with a warning. Since we have a long list of links, I think it is better to put the warning on top and not on each link. But I'm not sure if it is enough for screen reader users...
    https://blog.pope.tech/2024/01/02/how-to-make-external-links-accessible/
    https://www.digitala11y.com/external-links-in-or-out/
    https://www.w3.org/WAI/WCAG21/Techniques/general/G200

    @HLeithner
    Copy link
    Member

    it's common usage that if you leave the website the target is blank, if you want to change this then we should do this for the complete manual and not only add a warning on this one page. But be aware that you will break workflow for most people expecting this behavior.

    @drmenzelit
    Copy link
    Contributor Author

    No, I don't want to change the behavior. I was only giving some context to the topic ;-)

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

    Successfully merging this pull request may close these issues.

    2 participants