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 add-aspect documentation #1729

Merged
merged 4 commits into from
Aug 29, 2022
Merged

Conversation

amyleadem
Copy link
Contributor

@amyleadem amyleadem commented Jul 29, 2022

Related issue

Closes #1702

Preview link

Preview link:

Summary

The add-aspect utility was recently updated with expanded capabilities. This PR updates our documentation accurately represent the current state of add-aspect.

Solution

After checking all references to add-aspect or "aspect ratio" on our site, I found only a need to update the card documentation. The current utility documentation was still accurate.

⚠️ Note: I could not get any hits when searching the published site for "aspect ratio", despite having multiple instances of the term on the site. Searching for "aspect" and "ratio" also fail to get results. Is there anything we can do to fix this?


Before opening this PR, make sure you’ve done whichever of these applies to you:

  • Confirm that this code follows the 18F Front End Coding Style Guide and Accessibility Guide.
  • Run git pull origin [base branch] to pull in the most recent updates from your base and check for merge conflicts. (Often, the base branch is develop).
  • Run npm test and confirm that all tests pass.
  • Run your code through HTML_CodeSniffer and make sure it’s error free.

@@ -32,8 +32,6 @@ variants:
description: In combination with `usa-card--flag`, sets the media element on the right. (Flag cards display media on the left by default.)
- variant: "`.usa-card__media--inset`"
description: Indents the media element so it doesn't extend to the edge of the card.
- variant: "`.usa-card__media--set-aspect`"
Copy link
Contributor Author

Choose a reason for hiding this comment

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

This variant is no longer needed. Users can directly apply add-aspect utility classes without needing to use this set-aspect class.

@amyleadem amyleadem marked this pull request as ready for review July 29, 2022 14:55
Copy link
Contributor

@bonnieAcameron bonnieAcameron left a comment

Choose a reason for hiding this comment

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

This looks great. Clear and typo-free!

@thisisdano thisisdano merged commit 4410a9e into main Aug 29, 2022
@thisisdano thisisdano deleted the al-aspect-ratio branch August 29, 2022 18:27
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: Aspect ratio - Review and update documentation
4 participants