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: Fix token pages from audit (Part 1) #2366

Merged
merged 14 commits into from Dec 4, 2023
Merged

Conversation

amyleadem
Copy link
Contributor

@amyleadem amyleadem commented Nov 20, 2023

Summary

Updated component pages according to the findings reported in the code/developer content audit (Google Docs 🔒)

Note

To keep PR reviews manageable, this PR updates only the overview and color overview tokens pages. All other token page updates will be addressed in other PRs.

Warning

We will likely need to update the changelog dates before merge.

Related issue

Related to #2042

Preview link

Preview link:

Solution

Update code according to the findings in code/developer content audit (Google Docs 🔒).

Please note that all items highlighted yellow in the spreadsheet will be investigated/discussed in the last phase of the component page fixes.

Testing and review

  • Confirm that all updates are accurate and make sense
  • Confirm that updated code examples work without error
  • Confirm that all meaningful updates have a related changelog
    • "Meaningful" updates here mostly applied to adding or removing documentation about variants, dependencies, etc. Copy tweaks to add clarity were not considered meaningful, but a case could be made for them to be included.
  • Confirm grammar and spelling for all updates

@amyleadem amyleadem marked this pull request as ready for review November 27, 2023 19:01
@amyleadem amyleadem linked an issue Nov 27, 2023 that may be closed by this pull request
@amyleadem amyleadem changed the title USWDS-Site: Fix token pages from audit USWDS-Site: Fix token pages from audit (Part 1) Nov 27, 2023
Copy link
Contributor Author

Choose a reason for hiding this comment

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

Debating if these would be better as a single changelog entry. Curious to hear your thoughts.

Copy link
Contributor

@mahoneycm mahoneycm left a comment

Choose a reason for hiding this comment

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

Changes are logical and look great!

  • Changes are warranted
  • No spelling or grammatical error
  • All green changes from doc are present
    • Removed red-warm-50v references
    • Changed red-warm-50 references --> red.
    • Updated to "lg", font-ui-lg
    • Updated to "2xl", font-body-2xl
    • Changed primary base to green-cool-10, added link to system token page
    • Removed this reference. Instead can rely on the next sentence: "Pure white is the equivalent of grade 0"

Comment on lines 5 to 11
- date: 2023-11-28
summary: Updated token references in "Using design tokens" section.
affectsGuidance: true
githubPr: 2366
githubRepo: uswds-site
- date: 2023-11-28
summary: Updated the settings configuration code example.
Copy link
Contributor

Choose a reason for hiding this comment

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

Optional - change logs

If we wanted to consolidate these into one change log, we could do something along the lines of

Suggested change
- date: 2023-11-28
summary: Updated token references in "Using design tokens" section.
affectsGuidance: true
githubPr: 2366
githubRepo: uswds-site
- date: 2023-11-28
summary: Updated the settings configuration code example.
- date: 2023-11-28
summary: Updated token references and settings configuration example to match the current USWDS implementation.

@amyleadem amyleadem merged commit 6657997 into main Dec 4, 2023
11 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

USWDS-Site - Code audit: Fix inaccuracies in tokens pages
3 participants