USWDS-Site - Compile: Update settings example #1597
Merged
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Description
Closes #1590
Preview link: Getting started for developers - Phase 2
Problem
From the related issue: "The settings file example in docs would generate a warning for insufficient contrast, if the warnings hadn't been disabled. Since it's typical for people getting started to copy/paste examples, it would be better to have an initial file that didn't disable warnings and had contrasting colors."
Solution
Updated the example compile settings in Phase 2 of the Getting Started for Developers guide to include values that compile without warnings.
Testing
To test, open a sample project and use the current code sample from our docs but turn
$theme-show-compile-warnings
totrue
. Note the compile warnings.Then compile using the updated code sample. You should receive no compile warnings or errors.
Additional information
npm test
and make sure the tests for the files you have changed have passed.