Skip to content

Conversation

@thisisdano
Copy link
Contributor

@thisisdano thisisdano commented Jan 5, 2025

Adds links and references to the USWDS design kit for Figma and fixes a few lingering issues.

Adds links to USWDS design kit for Figma

How to check: Review the links on the Getting started for Designers page

Improves link formatting on Designers page

How to check: Review the links on the Getting started for Designers page

Aligns outer margin of all page elements to widescreen

How to check: On all pages, the banner, header, and main text section should all be centered on the screen, aligning with the identifier and the footer. See, for example, the homepage

Removes extraneous banner styles

How to check: Check that banner displays as expected. Look at all the code cut from custom styles.

Use Public Sans for documentation accordions

How to check: Check that the blue-header accordions on a page like Accordion use Public Sans.

Use Public Sans for UX alerts

How to check: Check that UX info alerts, like the one on File Input, use Public Sans

Properly center secondary nav at desktop width

How to check: On any page, at desktop width, check that the searh bar and buttons in the nav are properly vertically centered in the dark blue bar, and are aligned with other elements on the right margin.

Remove extraneous webrick gem from Gemfile

How to check: Check that webrick is gone from the Gemfile at that it has effect on building with Jekyll.

Copy link
Contributor Author

@thisisdano thisisdano left a comment

Choose a reason for hiding this comment

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

Added code comments

gem 'rspec-core'
gem 'rspec-expectations'

gem "webrick", "~> 1.7"
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 does not do anything

Copy link
Contributor

Choose a reason for hiding this comment

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

Confirming, this didn't affect anything for me locally.

Copy link
Contributor

Choose a reason for hiding this comment

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

I have a hunch this was necessary at some point (having been looking at old blog posts of people trying to get jekyll working over the years) but i guess not anymore. Ty for your service, webrick.

Comment on lines +3 to +5
<svg class="usa-icon" aria-hidden="true" focusable="false" role="img">
<use href="{{ site.baseurl }}/assets/img/sprite.svg#file_download"></use>
</svg>
Copy link
Contributor Author

Choose a reason for hiding this comment

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

Adds download icon

Comment on lines +7 to +9
<svg class="usa-icon" aria-hidden="true" focusable="false" role="img">
<use href="{{ site.baseurl }}/assets/img/sprite.svg#file_download"></use>
</svg>
Copy link
Contributor Author

Choose a reason for hiding this comment

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

Adds download icon

Comment on lines +13 to +15
<svg class="usa-icon" aria-hidden="true" focusable="false" role="img">
<use href="{{ site.baseurl }}/assets/img/sprite.svg#file_download"></use>
</svg>
Copy link
Contributor Author

Choose a reason for hiding this comment

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

Adds download icon

Comment on lines 3 to 4
href="https://github.com/uswds/uswds-for-designers/releases/download/v3.0.0/uswds-for-designers-v3.0.0.zip"
onclick="ga('send', 'event', 'Downloaded design files', 'Clicked download design files button inside site');">
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 will work once we publish uswds-for-designers. I've collected everything into a single link. The previous iteration had two links that led to the same file only to collect an analytics event. This type of information isn't worth the UX hit

letter-spacing: letter-spacing(1);
margin-bottom: units(1);
margin-top: 0;
text-transform: uppercase;
Copy link
Contributor Author

Choose a reason for hiding this comment

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

Added to remove the need for the typeset-h6 mixin that I'll actually remove in the followup PR to this one

Comment on lines +1459 to +1477
.link-download-subtext {
margin-left: units(3);
}

&::before {
@include u-square(1.5);
background: url("#{$image-path}/icon-download.png") no-repeat 0 0;
background: url("#{$image-path}/icon-download.svg") no-repeat 0 0;
background-size: 100%;
content: "";
display: inline-block;
margin-bottom: 0;
margin-right: units(1.5);
.link__group-download {
.link-download {
@include u-measure(5);
align-items: center;
background-color: color("blue-warm-5");
border-radius: radius("md");
display: flex;
padding: units(2);
}
}

.link-download-subtext {
margin-left: units(3);
.usa-icon {
height: units(3);
margin-right: units(1);
width: units(3);
}
Copy link
Contributor Author

Choose a reason for hiding this comment

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

Use a more appealing download link style

Comment on lines 2463 to 2466

.usa-accordion__heading {
@include typeset("lang", $theme-body-font-size, 1);
}
Copy link
Contributor Author

Choose a reason for hiding this comment

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

Use Public Sans in our docs accordions

Copy link
Contributor

Choose a reason for hiding this comment

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

issue: This affects the accordion preview too.

image

Comment on lines -2700 to -2702
.site-banner {
$banner-context: "Banner";
$site-banner-background-color: "ink";
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 whole section is 90% redundant

Copy link
Contributor

Choose a reason for hiding this comment

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

@thisisdano glad to see these styles removed. This work closes #1962.

I went ahead and closed the previous PR #2743.

Comment on lines +3759 to +3768

.usa-alert.site-alert {
.usa-alert__body {
@include typeset("lang");
}

.usa-alert__heading {
@include typeset("lang", "lg", 1);
}
}
Copy link
Contributor Author

Choose a reason for hiding this comment

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

Use Public Sans in our UX alerts

Copy link
Contributor

Choose a reason for hiding this comment

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

issue: On File Input the first alert is public sans, but the one in guidance is still source sans pro.

image

image

@thisisdano thisisdano marked this pull request as ready for review January 6, 2025 06:41
@thisisdano thisisdano requested a review from a team as a code owner January 6, 2025 06:41
@thisisdano thisisdano linked an issue Jan 6, 2025 that may be closed by this pull request
2 tasks
@thisisdano thisisdano requested review from amyleadem and mejiaj January 6, 2025 21:20
@mejiaj mejiaj self-assigned this Jan 6, 2025
There was a typo in the release ZIP, unfortunately
mejiaj
mejiaj previously approved these changes Jan 7, 2025
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.

LGTM, issues resolved. Thanks!

@amyleadem amyleadem self-assigned this Jan 7, 2025
Copy link
Contributor

@amyleadem amyleadem left a comment

Choose a reason for hiding this comment

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

Looking pretty good! I've added a few comments below with some change requests.

Confirmed the following in Safari, Firefox, and Chromium at mobile and desktop widths:

  • Confirm the download links work as expected on the Getting started for Designers page
    • Note, the “USWDS design kit for Figma” link still points to the Truss implementation. I’ve added a comment below asking if we want to update that
  • Confirm that the updated link styles on the Getting started for Designers pageare consistent across screen widths and matches site styles
  • Review outer margin alignment of all page elements to widescreen
    • Noting that there is a slight misalignment in the left margin for the usa-nav at desktop widths
      image
  • Check that banner displays as expected
  • Check that the blue-header accordions use Public Sans
  • Check that UX info alerts use Public Sans
  • Check that the a11y notes on component pages use Public Sans
  • On any page, at desktop width, check that the search bar and buttons in the nav are properly vertically centered in the dark blue bar, and are aligned with other elements on the right margin.
  • Check that webrick is gone from the Gemfile
  • Check that it does not affect Jekyll build
  • Confirm all changelogs are present and accurate
    • Note: We need a changelog on the “Getting started for designers” page about the link and content updates there.

Co-authored-by: Amy Leadem <93996430+amyleadem@users.noreply.github.com>
@thisisdano
Copy link
Contributor Author

Thanks @amyleadem — added the copy changes, working on the other issues now

@thisisdano
Copy link
Contributor Author

@amyleadem This is now ready for re-review

Copy link
Contributor

@amyleadem amyleadem left a comment

Choose a reason for hiding this comment

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

Found just one small regression in the mobile nav, documented in the comment below. Other than that, looking good!


.site-nav__inner {
min-height: units($site-inner-nav-height);
padding-left: units(2);
Copy link
Contributor

Choose a reason for hiding this comment

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

issue: I noticed a regression in the mobile nav related to this update:

image

We'll need to target the desktop display only for this padding.

Copy link
Contributor Author

Choose a reason for hiding this comment

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

:headslap:

@thisisdano
Copy link
Contributor Author

OK, fixed!

@thisisdano
Copy link
Contributor Author

I fixed a few more Public Sans issues while I was at it:

Accordions in migrations docs

old:
Screenshot 2025-01-07 at 9 57 46 PM

new:
Screenshot 2025-01-07 at 9 58 02 PM

Various alerts

old:
Screenshot 2025-01-07 at 10 01 28 PM

new:
Screenshot 2025-01-07 at 10 01 05 PM

Demo buttons

old:
Screenshot 2025-01-07 at 10 03 23 PM

new:
Screenshot 2025-01-07 at 10 03 08 PM

What's new cards

old:
Screenshot 2025-01-07 at 10 05 31 PM

new:
Screenshot 2025-01-07 at 10 05 42 PM

Security releases

old:
Screenshot 2025-01-07 at 10 07 14 PM

new:
Screenshot 2025-01-07 at 10 07 25 PM

Copy link
Contributor

@amyleadem amyleadem left a comment

Choose a reason for hiding this comment

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

LGTM!

Copy link
Contributor

@heymatthenry heymatthenry left a comment

Choose a reason for hiding this comment

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

I know this was a journey, @thisisdano. Congrats on reaching the farther shore.

@heymatthenry heymatthenry merged commit 9029e10 into main Jan 8, 2025
11 checks passed
@heymatthenry heymatthenry deleted the dw-update-design-assets branch January 8, 2025 18:15
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 - Getting started for designers: Add Figma Design Kit (beta) link

5 participants