USWDS-Site - Documentation: Improve clarity in sample layout settings

[mejiaj]

From a ZenDesk question.

To turn on or off breakpoints as mentioned on this page
https://designsystem.digital.gov/utilities/layout-grid/#sass-mixins
, what is the name/location of the scss file that I should modify?

Problem

It's not clear where these settings should be added in the code examples.

Expected

A file name or more accurate example of how they are used should be added.

A possible solution:

+ /* _uswds-theme.scss */

// Values are set as units tokens.

- $theme-column-gap-sm:               2px;
-  $theme-column-gap-md:               2;
-  $theme-column-gap-lg:               3;
-  $theme-column-gap-mobile:           2;
-  $theme-column-gap-desktop:          4;
-  $theme-grid-container-max-width:    'desktop';
-  $theme-site-margins-breakpoint:     'desktop';
-  $theme-site-margins-width:          4;
-  $theme-site-margins-mobile-width:   2;

+@use "uswds-core" with (
+ $theme-column-gap-sm:               2px;
+  $theme-column-gap-md:               2;
+  $theme-column-gap-lg:               3;
+  $theme-column-gap-mobile:           2;
+  $theme-column-gap-desktop:          4;
+  $theme-grid-container-max-width:    'desktop';
+  $theme-site-margins-breakpoint:     'desktop';
+  $theme-site-margins-width:          4;
+  $theme-site-margins-mobile-width:   2;
+ )

Source: _utilities/layout-grid.md

[mejiaj]

@amyleadem can you confirm if this was addressed in your existing refactor work?

[amyleadem]

It looks like we haven't addressed this yet. We flagged it in the code documentation audit, but it has not yet been addressed. I've added a note in the spreadsheet that the item will be addressed in this issue.

[amyleadem]

Re-assigning to @mahoneycm to see if it has been addressed in #2276

[mahoneycm]

This issue should be completed as part of #2276 where we are discussing replacing this section with a link to the settings guidance or by capturing the relevant information in site.data.settings.spacing.contents

[mahoneycm]

Closing in favor of #2210