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

Enhance accessibility by adding ARIA attributes and IDs to navigation elements #243

Merged

Conversation

Faith-K-commits
Copy link
Contributor

@Faith-K-commits Faith-K-commits commented Oct 16, 2024

Fixes

Description

This pull request improves the accessibility of navigation elements by adding appropriate aria-label and aria-labelledby attributes. These changes help screen readers better understand the purpose of the navigation sections.

Technical details

  • The aria-label attribute has been added to provide clear labels for screen readers where the menu purpose was not explicitly labeled.
  • aria-labelledby has been applied when appropriate, referencing headings where present.

Tests

To verify the changes:

  1. Use a screen reader to navigate the menus.
  2. Confirm that the menus are announced with their purpose.
  3. Ensure there are no conflicts or missing labels in the navigation sections.

Checklist

  • My pull request has a descriptive title (not a vague title like Update index.md).
  • My pull request targets the default branch of the repository (main or master).
  • My commit messages follow best practices.
  • My code follows the established code style of the repository.
  • I added or updated tests for the changes I made (if applicable).
  • I added or updated documentation (if applicable).
  • I tried running the project locally and verified that there are no
    visible errors.

Developer Certificate of Origin

For the purposes of this DCO, "license" is equivalent to "license or public domain dedication," and "open source license" is equivalent to "open content license or public domain dedication."

Developer Certificate of Origin
Developer Certificate of Origin
Version 1.1

Copyright (C) 2004, 2006 The Linux Foundation and its contributors.
1 Letterman Drive
Suite D4700
San Francisco, CA, 94129

Everyone is permitted to copy and distribute verbatim copies of this
license document, but changing it is not allowed.


Developer's Certificate of Origin 1.1

By making a contribution to this project, I certify that:

(a) The contribution was created in whole or in part by me and I
    have the right to submit it under the open source license
    indicated in the file; or

(b) The contribution is based upon previous work that, to the best
    of my knowledge, is covered under an appropriate open source
    license and I have the right under that license to submit that
    work with modifications, whether created in whole or in part
    by me, under the same open source license (unless I am
    permitted to submit under a different license), as indicated
    in the file; or

(c) The contribution was provided directly to me by some other
    person who certified (a), (b) or (c) and I have not modified
    it.

(d) I understand and agree that this project and the contribution
    are public and that a record of the contribution (including all
    personal information I submit with it, including my sign-off) is
    maintained indefinitely and may be redistributed consistent with
    this project or the open source license(s) involved.

@Faith-K-commits Faith-K-commits requested review from a team as code owners October 16, 2024 17:37
@Faith-K-commits Faith-K-commits requested review from TimidRobot, possumbilities, Dhruvi16 and zackkrida and removed request for a team October 16, 2024 17:37
Copy link

netlify bot commented Oct 16, 2024

Deploy Preview for vocabulary-docs ready!

Name Link
🔨 Latest commit c761c0a
🔍 Latest deploy log https://app.netlify.com/sites/vocabulary-docs/deploys/6719d13bd9719500082e5c1c
😎 Deploy Preview https://deploy-preview-243--vocabulary-docs.netlify.app
📱 Preview on mobile
Toggle QR Code...

QR Code

Use your smartphone camera to open QR code link.

To edit notification comments on pull requests, go to your Netlify site configuration.

@possumbilities possumbilities changed the title Enhance accessibility by adding ARIA attributes and IDs to navigation… Enhance accessibility by adding ARIA attributes and IDs to navigation elements Oct 21, 2024
@possumbilities
Copy link
Contributor

@Faith-K-commits Hi! I added some comments that would need to repeat across the other contexts.

I also believe you might have missed the sidebar menu(s) which appear on several contexts (like archive-page.html). It would also be a good idea to check the footer as well.

A PR here should address all occurrences of nav elements in all contexts.

@Faith-K-commits
Copy link
Contributor Author

Hi @possumbilities
I have taken note of the comments and will update the nav element in all contexts.

@Faith-K-commits
Copy link
Contributor Author

Hello @possumbilities, I have made the changes in all occurances of nav element in all contexts.
Kindly review.

@possumbilities
Copy link
Contributor

Hi @Faith-K-commits Good work, there's a few more adjustments but you're getting close!

@possumbilities possumbilities removed the request for review from TimidRobot October 23, 2024 20:59
@Faith-K-commits
Copy link
Contributor Author

Hi @possumbilities , thank you for your feedback. I have removed the redundant word heading in the files.

Copy link
Contributor

@possumbilities possumbilities left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This is wonderful! Approved. Thank you for this contribution!

@possumbilities possumbilities merged commit abe4a24 into creativecommons:main Oct 24, 2024
4 checks passed
@Faith-K-commits
Copy link
Contributor Author

You're welcome!

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
Archived in project
2 participants