Updating documentation #593
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
georgewrmarshall
added
documentation
| @@ -1,4 +1,5 @@ | |||
| import { ComponentStory, ComponentMeta } from '@storybook/react'; | |||
There was a problem hiding this comment.
Just updating deprecated components in Typography story will save a docs update for another PR to keep this one a reasonable size
| @@ -103,10 +103,10 @@ Follow these steps to below to get the library up and running locally. | |||
|
|
|||
| ### Setup | |||
|
|
|||
| - Install [Node.js](https://nodejs.org) version 12 | |||
| - Install [Node.js](https://nodejs.org) version 16 | |||
There was a problem hiding this comment.
Updating node version to 16 as stated in the package.json
Line 88 in 0910f70
There was a problem hiding this comment.
Makes sense - nvmrc is also already at 16
| - If you are using [nvm](https://github.com/creationix/nvm#installation) (recommended) running `nvm use` will automatically choose the right node version for you. | ||
| - Install [Yarn v1](https://yarnpkg.com/en/docs/install) | ||
| - Run `yarn setup` to install dependencies and run any requried post-install scripts | ||
| - Run `yarn setup` to install dependencies and run any required post-install scripts |
There was a problem hiding this comment.
Fixing spelling mistake
georgewrmarshall
changed the title
georgewrmarshall
changed the title
georgewrmarshall
changed the title
garrettbear
approved these changes
Jan 22, 2024
| @@ -103,10 +103,10 @@ Follow these steps to below to get the library up and running locally. | |||
|
|
|||
| ### Setup | |||
|
|
|||
| - Install [Node.js](https://nodejs.org) version 12 | |||
| - Install [Node.js](https://nodejs.org) version 16 | |||
There was a problem hiding this comment.
Makes sense - nvmrc is also already at 16
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.
Description
This PR updates the documentation for the design tokens to provide better usage and explanations for
The main updates include:
ComponentStory,ComponentMetaScreenshots/Screencasts
Before
before720.mov
After
after720.mov
Manual testing steps