Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

USWDS - Docs: Add usage instructions to component settings. #1219

Merged
merged 20 commits into from
Jun 7, 2021

Conversation

mejiaj
Copy link
Contributor

@mejiaj mejiaj commented Apr 30, 2021

Description

Closes #1017 and #1221. This adds descriptions to component settings.

Preview links

Settings page →
Component pages →

Additional information

  • Uses consistent punctuation for Variants and Settings
  • Fixes broken references to some Component subsections
  • Removes duplicate keys
  • Checks setting exists before creating <code> in settings table
  • Corrects package references (Related: USWDS - Create process list package →)
  • Adds links to guidance and package info on Footer

Before you hit Submit, make sure you’ve done whichever of these applies to you:

  • Follow the 18F Front End Coding Style Guide and Accessibility Guide.
  • Run npm test and make sure the tests for the files you have changed have passed.
  • Run your code through HTML_CodeSniffer and make sure it’s error free.
  • Title your pull request using this format: [Website] - [UI component]: Brief statement describing what this pull request solves.

@mejiaj mejiaj marked this pull request as ready for review May 3, 2021 12:52
@mejiaj mejiaj requested a review from thisisdano May 3, 2021 12:52
Copy link
Member

@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.

Let's merge this even though I'm not sure the trailing period is the right punctuation. There are other good changes in here and at least this is consistent

@thisisdano thisisdano merged commit 7975930 into main Jun 7, 2021
@mejiaj mejiaj deleted the jm-docs-add-usage-instructions branch March 23, 2024 21:06
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 - Documentation: Add usage instructions to empty settings.
2 participants