Remove "Usage" section of design.login.gov #228
Merged
Conversation
This file contains 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
aduth
approved these changes
Jul 13, 2021
README.md
Outdated
| @@ -81,3 +89,94 @@ Before starting, make sure that all changes intended for release should be merge | |||
| - The release version should match the version just published to `npm` (for example, `v2.1.5`). | |||
| - Use the version name as the release title. | |||
| - Use the release notes to link to any important issues or pull requests that were addressed in the release. You may copy this from `CHANGELOG.md`. | |||
|
|
|||
| ## Use with Rails | |||
There was a problem hiding this comment.
Would it make sense to group the two "Use with/as" headings under a "Usage" heading? Maybe also the Jekyll plugin if we reincorporate it per Zach's comment.
e.g.
## Usage
...
### Use with Rails
...
### Use as a JavaScript package
...
* Remove custom Accordion close button element **Why**: Maintenance: - Limit divergence from USWDS, facilitating ongoing maintenance and reducing potential confusion introduced by enhancements exclusive to the login.gov Design System. Accessibility: - The button's behavior is duplicative with the toggle, where the additional tab stop may be excessive as repeated content. - Collapsing an accordion by the close button causes a focus loss ([SC 2.4.7](https://www.w3.org/TR/UNDERSTANDING-WCAG20/navigation-mechanisms-focus-visible.html), [SC 2.4.3](https://www.w3.org/WAI/WCAG21/Understanding/focus-order.html)) - The relationship between the button and controlled content is not clearly indicated (e.g. [`aria-controls`](https://www.w3.org/TR/wai-aria-1.1/#aria-controls)) * Remove unused variable $icon-size * Restore border radius to accordion content bottom border * Clarify removal of JavaScript exported member
Co-authored-by: Andrew Duthie <[email protected]>
Co-authored-by: Andrew Duthie <[email protected]>
Co-authored-by: Andrew Duthie <[email protected]>
Co-authored-by: Andrew Duthie <[email protected]>
|
@aduth updates made. Re-requested review before 🚀 please 😄 |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
This pull request transitions "Usage" of the design system from living on design.login.gov as a
.mdfile to being part of the README. As the user is primarily internal team members, it makes sense to keep this installation and usage information in one place (instead of two).