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 4) #2386

Open
wants to merge 20 commits into
base: main
Choose a base branch
from

Conversation

amyleadem
Copy link
Contributor

@amyleadem amyleadem commented Dec 4, 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 some of the tokens pages. All other token page updates will be addressed in other PRs.

Important

We need to update changelog dates before merge.

Related issue

Related to #2042

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 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 self-assigned this Dec 14, 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.

Important

The u-opacity mixin does not currently exist in USWDS, and it looks like it hasn't for some time. This is likely a bug and is documented in uswds/uswds#5881. Should we remove the reference to it here?

Comment on lines -108 to -122
<tr>
<th scope="row" data-title="Context">
<span class="font-lang-3">setting</span>
</th>
<td data-title="Description">
<span>
<a href="{{ site.baseurl }}/design-tokens/opacity/" class="token">opacity</a>
</span>
</td>
<td data-title="Example">
<span>
$theme-hover-opacity: <code>50</code>
</span>
</td>
</tr>
Copy link
Contributor Author

@amyleadem amyleadem Apr 30, 2024

Choose a reason for hiding this comment

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

Note

I removed some settings examples in this PR because they do not exist in USWDS and I couldn't find an alternative theme setting that accepted these tokens. My goal was to minimize confusion and prevent users from trying to bring a non-existent setting into their config.

Please flag if you feel that removing these examples is too opinionated or would cause more confusion. Also let me know if you find a suitable setting to include here.

Comment on lines -129 to +133
$theme-nav-column-flex: <code>4</code>
$theme-megamenu-columns: <code>4</code>
Copy link
Contributor Author

Choose a reason for hiding this comment

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

Not sure if this is a suitable replacement, but was the only setting I could find that was pulled into u-flex. Please let me know if this feels wrong to include here and/or if you have a suitable replacement.

@amyleadem amyleadem marked this pull request as ready for review April 30, 2024 21:02
type: token
changelogURL:
items:
- date: NNNN-NN-NN
Copy link
Contributor Author

Choose a reason for hiding this comment

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

Important

We need to update changelog dates before merge

@amyleadem amyleadem added this to the 2024.06 June milestone May 20, 2024
Copy link
Contributor

@mejiaj mejiaj left a comment

Choose a reason for hiding this comment

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

Thanks for these fixes @amyleadem! Updated branch and approved.

@mejiaj mejiaj requested review from thisisdano and removed request for mahoneycm August 22, 2024 15:40
@brunerae brunerae removed this from the 2024.06 June milestone Sep 26, 2024
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.

3 participants