Skip to content

Commit

Permalink
docs: Adding README to component library folder (#8104)
Browse files Browse the repository at this point in the history
## **Description**

This PR introduces a README for the component library. The README serves
as a guide for designers and developers, providing necessary information
about the usage, storybook and support. It also provides us with an
entry point from external Design System docs

## **Related issues**

Fixes: #8103

## **Manual testing steps**

1. Open the readme 
2. Check for spelling, gramma and if the information is correct
3. Check links work

## **Screenshots/Recordings**

<!-- If applicable, add screenshots and/or recordings to visualize the
before and after of your change. -->

### **Before**


https://github.com/MetaMask/metamask-mobile/assets/8112138/ba2d5dd1-c503-41dc-adac-73d19a803521

### **After**


https://github.com/MetaMask/metamask-mobile/assets/8112138/50f46b01-dc31-439a-88c7-2be097be4fb5

## **Pre-merge author checklist**

- [x] I’ve followed [MetaMask Coding
Standards](https://github.com/MetaMask/metamask-mobile/blob/main/.github/guidelines/CODING_GUIDELINES.md).
- [x] I've clearly explained what problem this PR is solving and how it
is solved.
- [x] I've linked related issues
- [x] I've included manual testing steps
- [x] I've included screenshots/recordings if applicable
- [x] I’ve included tests if applicable
- [x] I’ve documented my code using [JSDoc](https://jsdoc.app/) format
if applicable
- [x] I’ve applied the right labels on the PR (see [labeling
guidelines](https://github.com/MetaMask/metamask-mobile/blob/main/.github/guidelines/LABELING_GUIDELINES.md)).
Not required for external contributors.
- [x] I’ve properly set the pull request status:
  - [ ] In case it's not yet "ready for review", I've set it to "draft".
- [x] In case it's "ready for review", I've changed it from "draft" to
"non-draft".

## **Pre-merge reviewer checklist**

- [ ] I've manually tested the PR (e.g. pull and build branch, run the
app, test code being changed).
- [ ] I confirm that this PR addresses all acceptance criteria described
in the ticket it closes and includes the necessary testing evidence such
as recordings and or screenshots.
  • Loading branch information
georgewrmarshall authored Dec 15, 2023
1 parent 9884203 commit fd98095
Showing 1 changed file with 13 additions and 0 deletions.
13 changes: 13 additions & 0 deletions app/component-library/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,13 @@
# Component Library

This folder contains design system components that are built 1:1 with the Figma [DS Components](https://www.figma.com/file/HKpPKij9V3TpsyMV1TpV7C/DS-Components?node-id=16-6) UI kit and should be used where possible in all UI feature work.

If you are a designer you can visit the [MetaMask Design System Guides (Design)](https://www.notion.so/MetaMask-Design-System-Guides-Design-f86ecc914d6b4eb6873a122b83c12940?pvs=4).

## Storybook

We document our components using Storybook. Please read the [Documentation Guidelines](../../storybook/DOCUMENTATION_GUIDELINES.md) to get up and running.

## Support

If internal folks have any questions please reach out the design system team via the internal slack channel [#metamask-design-system](https://consensys.slack.com/archives/C0354T27M5M) or tag us with the handle `@metamask-design-system-team` 💁

0 comments on commit fd98095

Please sign in to comment.