USWDS: revise README for clarity and consistency#6762
Open
annepetersen wants to merge 1 commit into
Open
Conversation
Updated README.md to improve clarity and consistency. Removed a 404-ing badge.
Contributor
|
✅ All commits on this PR have a verified signature. Thanks! |
chandracarney
approved these changes
Jul 16, 2026
| [](https://circleci.com/gh/uswds/uswds/tree/develop) [](https://www.npmjs.com/package/uswds) [](https://www.npmjs.com/package/uswds) [](https://github.com/uswds/uswds/issues) [](https://github.com/prettier/prettier) | ||
|
|
||
| The [United States Web Design System](https://designsystem.digital.gov) includes a library of open source UI components and a visual style guide for U.S. federal government websites. | ||
| The [United States Web Design System](https://designsystem.digital.gov) is a toolkit of principles, guidance, and code — a library of public domain and open source user interface components and a visual style guide designed for U.S. federal government websites, but useful in many other applications. |
Contributor
There was a problem hiding this comment.
I like these tweaks 👍
| - The CSS organization and naming conventions follow **[18F’s Engineering Guide](https://guides.18f.org/engineering/languages-runtimes/css/#naming)**. | ||
| - We format our code with [Prettier](https://prettier.io/), per the formatting section of the **[18F Engineering Guide](https://guides.18f.org/engineering/languages-runtimes/css/#formatting)**. | ||
| - CSS selectors are **prefixed** with `usa` (For example: `.usa-button`). This identifier helps the design system avoid conflicts with other styles on a site which are not part of USWDS. | ||
| - CSS selectors are **prefixed** with `usa` (For example: `.usa-button`) — this identifier helps prevent conflicts with non-USWDS styles. |
Contributor
There was a problem hiding this comment.
Wow, such a solid improvement to clarity! 👏
| ## Accessibility | ||
|
|
||
| The design system also meets the [WCAG 2.0 AA accessibility guidelines](https://www.w3.org/TR/WCAG20/) and conforms to the standards of [Section 508 of the Rehabilitation Act](http://www.section508.gov/). Additionally, we try to meet the requirements of [WCAG 2.1](https://www.w3.org/TR/WCAG21/). | ||
| The design system meets [WCAG 2.0 AA accessibility guidelines](https://www.w3.org/TR/WCAG20/) and conforms to the standards of [Section 508 of the Rehabilitation Act](http://www.section508.gov/). We work toward meeting the requirements of [WCAG 2.1](https://www.w3.org/TR/WCAG21/). |
Contributor
There was a problem hiding this comment.
I should revisit if we can update to "meets 2.1" and "towards...2.2" in the near future. And if there's anything really holding us back, if we can easily fix.
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
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.
Updated README.md to improve clarity and consistency.
Removed a 404-ing badge.