Skip to content
This repository has been archived by the owner on Nov 26, 2024. It is now read-only.

Updating documentation #593

Merged
merged 17 commits into from
Jan 23, 2024
Merged

Updating documentation #593

merged 17 commits into from
Jan 23, 2024

Conversation

georgewrmarshall
Copy link
Collaborator

@georgewrmarshall georgewrmarshall commented Jan 20, 2024

Description

This PR updates the documentation for the design tokens to provide better usage and explanations for

  • README
  • Introduction
  • Color introduction
  • Brand colors
  • Theme colors

The main updates include:

  • Updating deprecated storybook components such as ComponentStory, ComponentMeta
  • Improving documentation focusing on usage and the why

Screenshots/Screencasts

Before

before720.mov

After

after720.mov

Manual testing steps

  1. Go to the latest storybook build of this PR
  2. Read through pages listed above
  3. Check they make sense and that stories are working correctly

@georgewrmarshall georgewrmarshall self-assigned this Jan 20, 2024
@georgewrmarshall georgewrmarshall added documentation Improvements or additions to documentation code Issue related to code work and removed code Issue related to code work labels Jan 20, 2024
@metamaskbot
Copy link
Collaborator

Builds ready [28944fe]

Storybook: Storybook

@georgewrmarshall georgewrmarshall added the color Tokens related to color label Jan 20, 2024
@@ -1,4 +1,5 @@
import { ComponentStory, ComponentMeta } from '@storybook/react';
Copy link
Collaborator Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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
Copy link
Collaborator Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Updating node version to 16 as stated in the package.json

"node": "^16.20.0"

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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
Copy link
Collaborator Author

@georgewrmarshall georgewrmarshall Jan 20, 2024

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Fixing spelling mistake

@metamaskbot
Copy link
Collaborator

Builds ready [7c0223c]

Storybook: Storybook

@metamaskbot
Copy link
Collaborator

Builds ready [ed53249]

Storybook: Storybook

@metamaskbot
Copy link
Collaborator

Builds ready [ec3cd2e]

Storybook: Storybook

@georgewrmarshall georgewrmarshall marked this pull request as ready for review January 22, 2024 16:51
@georgewrmarshall georgewrmarshall requested a review from a team as a code owner January 22, 2024 16:51
@georgewrmarshall georgewrmarshall changed the title Updating documentation Updating documentation (Broken) Jan 22, 2024
@georgewrmarshall georgewrmarshall changed the title Updating documentation (Broken) Updating documentation (DO NOT MERGE) Jan 22, 2024
@metamaskbot
Copy link
Collaborator

Builds ready [c2c8e48]

Storybook: Storybook

@metamaskbot
Copy link
Collaborator

Builds ready [8fa3991]

Storybook: Storybook

@georgewrmarshall georgewrmarshall changed the title Updating documentation (DO NOT MERGE) Updating documentation Jan 22, 2024
@metamaskbot
Copy link
Collaborator

Builds ready [c95bad4]

Storybook: Storybook

@metamaskbot
Copy link
Collaborator

Builds ready [31bec54]

Storybook: Storybook

@metamaskbot
Copy link
Collaborator

Builds ready [aa83d99]

Storybook: Storybook

@@ -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
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Makes sense - nvmrc is also already at 16

@georgewrmarshall georgewrmarshall merged commit 0e4c543 into main Jan 23, 2024
7 checks passed
@georgewrmarshall georgewrmarshall deleted the docs/updating-documentation branch January 23, 2024 00:18
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
color Tokens related to color documentation Improvements or additions to documentation
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants