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

USWDS-Site: Update the heading structure on component pages with multiple variants #2601

Closed
Tracked by #2414
amyleadem opened this issue Apr 3, 2024 · 0 comments · Fixed by #2608
Closed
Tracked by #2414
Assignees
Labels
Affects: Accessibility 🟡 Relates to the accessibility of our components Role: Dev Development/engineering skills needed
Milestone

Comments

@amyleadem
Copy link
Contributor

amyleadem commented Apr 3, 2024

Summary

Evaluate the header structure for component pages with multiple variant sections, like the heading page. More details in the comments below:

Header page:

Thanks for adding the in-page nav here. I see some issues with the heading levels here, and I'm not sure this PR is the place to fix them, but I wanted to call them out. I think the "Component preview," "Component code," "Guidance," etc., headings should be nested under each heading type (e.g., nested under "Basic header"). To me, it is not logical for these to be at the same level as the heading type--they belong under the heading type.

Originally posted by @sarah-sch in #2595 (comment)

Language selector page:

Similar to the header nav, I don't think the preview, code, guidance headers, etc. should have the same heading level as the language selector type under which they fall. This guidance should be nested at a lower heading level.
Originally posted by @sarah-sch in #2595 (comment)

@github-actions github-actions bot added the Status: Triage We're triaging this issue and grooming if necessary label Apr 3, 2024
@amyleadem amyleadem changed the title USWDS-Site: Assess heading structure on long component pages USWDS-Site: Update the heading structure on component pages with multiple variants Apr 3, 2024
@amyleadem amyleadem self-assigned this Apr 3, 2024
@amyleadem amyleadem added Role: Dev Development/engineering skills needed and removed Status: Triage We're triaging this issue and grooming if necessary labels Apr 3, 2024
@amyleadem amyleadem added this to the 2024.04 April milestone Apr 8, 2024
@mejiaj mejiaj added the Affects: Accessibility 🟡 Relates to the accessibility of our components label Apr 30, 2024
@brunerae brunerae modified the milestones: 2024.04 April, 2024.05 May May 13, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Affects: Accessibility 🟡 Relates to the accessibility of our components Role: Dev Development/engineering skills needed
Projects
Status: Done
Development

Successfully merging a pull request may close this issue.

3 participants