-
Notifications
You must be signed in to change notification settings - Fork 793
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
The Accessibility testing status section of the Accessibility tab should follow the Development considerations #3960
Comments
Tried moving the accessibility status to the bottom of the page, as per #3960 Since the H3 is generated in code, I'm just leaving it as is. Expectation is that this will be a subsection of Development considerations, which works fine. Not showing up in preview.
@laurenmrice Just wondering about the status of this. I believe this is a quick change, especially if this is left as an H3. I have attempted this as a POC on the accordion page with #4184 I am happy to carry this out across all the component pages if this interim change works and has support. |
@alisonjoseph @mbgower We just discussed and confirmed this topic in design crit, we are going to leave this as an H3 and move it under "Development considerations". |
Renamed and updated issue to match decision. |
* Update accessibility.mdx Tried moving the accessibility status to the bottom of the page, as per #3960 Since the H3 is generated in code, I'm just leaving it as is. Expectation is that this will be a subsection of Development considerations, which works fine. Not showing up in preview. * Move accessibility testing to bottom of tabbed content Changed 28 components that were previously revised to the standard accessibility tab layout * Relocate testing on non-standard pages Move the accessibility testing to the bottom of pages that have not been updated to the current accessibility tab template * Corrections from manual check A number of pages had the A11yStatus formed with indented code, so my GSR failed to locate. As well, a manual check of each page (which I did by navigating to the Accessibility tab and clicking the Development considerations on-page link), showed that a few of the on-page links were malformed. * Update accessibility.mdx Missed popover testing section * Removed old testing information These five components had not had their Accessibility tab info updated due to various reasons. We elected to strip out the old testing results. I left the H2 for Testing in place. * Update accessibility.mdx Adding top description to list component.
Summary
The new information for accessibility testing is very welcome, but it could be better positioned and potentially needs its heading hierarchy addressed
Relevant information
The new accessibility testing information appears at the top of the Accessibility tab for each component.
While this information will be valuable to some, it is arguably less valuable to designers (the primary target group for the Accessibility tab) than the previously existing information on the page (What Carbon provides, Design recommendations, Development considerations). This is especially the case since the accessibility summary has already been surfaced near the top of the Usage page. As well, activating any of that summary information on the Usage page relocates the user to this section. In other words, the content is already highly discoverable without being placed at the start of the accessibility information.
A concern with it preceding the main guidance intended for designers ("What Carbon provides") is that designers are less likely to identify the key concepts on the page, when confronted with testing information that may not be pertinent to their role.
I recommend it be placed at the bottom of the page. Its heading could be listed as part of the in-page TOC links at the top (from which it is currently absent), like so:
What Carbon provides
Design recommendations
Development considerations
Accessibility testing status
Finally, it is currently presented as an H3. Especially given its current position, this is a hierarchical failure, since it precedes the first H2 on the page. At the least, if left in this position, it needs to be promoted to an H2. If the testing information is relocated to the bottom of the page, one can make the case that the testing status is a child of the Development considerations, but I think it can also work as a peer.
Conclusion from refinement
We agree and we will move the testing section to the bottom
and add an H2 heading[decided on Aug 6 call to leave as H3, mg]. Do this for all component pages. ~~The heading may be a part of the component so this may need to be a dev issue. ~~ [Since leaving as H3, unnecessary]The text was updated successfully, but these errors were encountered: