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 Descriptive Headings to Test Instructions and Criteria #379

Merged
merged 1 commit into from
Feb 3, 2022

Conversation

jkva
Copy link
Contributor

@jkva jkva commented Dec 9, 2021

This PR addresses the following item from PAC's "ARIA-AT App Screen Reader Accessibility Observations" document:

Within the content of a test, the lists of instructions, commands and assertions do not have accessible names, to help screen reader users understand their purpose and distinguish between the many lists on the page.

@jscholes this PR only covers the headings for test instructions and success criteria; the assertions table heading is covered by #375.


Effective changes:

  • add a h2 before "Test Instructions"
  • describe the instructions ol using idref
  • add a h2 before "Success Criteria"
  • describe the criteria ol using idref

@jkva jkva requested a review from jscholes December 9, 2021 13:41
Copy link
Contributor

@jscholes jscholes left a comment

Choose a reason for hiding this comment

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

@jkva I'm concerned about the heading hierarchy overlaps between this, #377, and #376. For instance, if #376 increases the level of what used to be a duplicate h1, it seems like the headings introduced in this PR (and maybe #377) should be higher? May be worth a double check.

@jkva
Copy link
Contributor Author

jkva commented Dec 10, 2021

@jscholes I've been aware of that as some of these PRs do indeed intersect. I'll merge a few together in a general "Heading Structure Improvements" PR.

@alflennik
Copy link
Contributor

Just let us know when you think this is ready for our review @jkva.

@jkva jkva dismissed jscholes’s stale review February 3, 2022 12:57

#369 is no longer relevant (see its closing comment), hence this PR is still valid.

@jkva
Copy link
Contributor Author

jkva commented Feb 3, 2022

@alflennik given the overarching PR #396 was closed (since some other PRs it contained have since been merged), this PR should still be merged, hence please review.

@evmiguel evmiguel merged commit 6358b58 into main Feb 3, 2022
@evmiguel evmiguel deleted the add-list-descriptive-headings branch February 3, 2022 17:17
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.

5 participants