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 custom api docs template to address a11y issues #216

Merged
merged 1 commit into from
Feb 13, 2025

Conversation

ericbuckley
Copy link
Collaborator

@ericbuckley ericbuckley commented Feb 12, 2025

Description

Developing a custom Handlebars template for Redoc to generate API documentation. This template enables us to override CSS rules and execute JavaScript functions to modify HTML tag attributes, aiming to resolve known accessibility (a11y) issues.

Related Issues

closes #198

Additional Notes

Using axe devtools to identify and help correct known a11y issues. These changes have resolved all known serious, critical, moderate and minor issues according to axe.

<--------------------- REMOVE THE LINES BELOW BEFORE MERGING --------------------->

Checklist

Please review and complete the following checklist before submitting your pull request:

  • I have ensured that the pull request is of a manageable size, allowing it to be reviewed within a single session.
  • I have reviewed my changes to ensure they are clear, concise, and well-documented.
  • I have updated the documentation, if applicable.
  • I have added or updated test cases to cover my changes, if applicable.
  • I have minimized the number of reviewers to include only those essential for the review.

Checklist for Reviewers

Please review and complete the following checklist during the review process:

  • The code follows best practices and conventions.
  • The changes implement the desired functionality or fix the reported issue.
  • The tests cover the new changes and pass successfully.
  • Any potential edge cases or error scenarios have been considered.

@ericbuckley ericbuckley added the a11y Making digital accessibility easier label Feb 12, 2025
@ericbuckley ericbuckley self-assigned this Feb 12, 2025
Copy link

codecov bot commented Feb 12, 2025

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 97.68%. Comparing base (f0d035a) to head (269b9b2).
Report is 2 commits behind head on main.

Additional details and impacted files
@@           Coverage Diff           @@
##             main     #216   +/-   ##
=======================================
  Coverage   97.68%   97.68%           
=======================================
  Files          32       32           
  Lines        1645     1645           
=======================================
  Hits         1607     1607           
  Misses         38       38           

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

@ericbuckley ericbuckley marked this pull request as ready for review February 12, 2025 23:20
Copy link
Collaborator

@m-goggins m-goggins left a comment

Choose a reason for hiding this comment

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

Looks good!

@ericbuckley ericbuckley merged commit c7aa14d into main Feb 13, 2025
17 checks passed
@ericbuckley ericbuckley deleted the fix/198-api-docs-a11y branch February 13, 2025 21:05
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
a11y Making digital accessibility easier
Projects
None yet
Development

Successfully merging this pull request may close these issues.

fix 508 issues on published API docs
2 participants