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 - In-page nav: Revisit page content #2245

Open
amyleadem opened this issue Aug 15, 2023 · 0 comments
Open

USWDS-Site - In-page nav: Revisit page content #2245

amyleadem opened this issue Aug 15, 2023 · 0 comments
Labels
Affects: Content Relates to content Role: Content Content/writing skills needed Type: Update A content update

Comments

@amyleadem
Copy link
Contributor

Summary

The in-page navigation component page does not follow the structure of other component pages. We should review the content on this page and make edits to better align this component with other USWDS documentation.

Here are some of the discrepancies:

  • Border is missing from the header. See example below.
    In-page nav (left) | Accordion (right)
    image
  • The "Using the in-page navigation component" section does not match the structure of other components. We should consider removing markup instructions and standardize the properties explanations.
  • The page needs a review for plain language. Items like "root margin" and "threshold" feel particularly opaque.
  • The bolded statements are not consistently complete sentences like on other pages. We should update these to be more meaningful.
@amyleadem amyleadem self-assigned this Aug 15, 2023
@github-actions github-actions bot added the Status: Triage We're triaging this issue and grooming if necessary label Aug 15, 2023
@mejiaj mejiaj added the Type: Bug A problem in the code label Aug 15, 2023
@amyleadem amyleadem added Type: Update A content update Affects: Content Relates to content Role: Content Content/writing skills needed and removed Status: Triage We're triaging this issue and grooming if necessary Type: Bug A problem in the code labels Aug 24, 2023
@amyleadem amyleadem removed their assignment Aug 24, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Affects: Content Relates to content Role: Content Content/writing skills needed Type: Update A content update
Projects
Status: Ready to Schedule
Development

No branches or pull requests

2 participants