Skip to content

Commit

Permalink
feat: Add DS Guides link to component readmes (#8400)
Browse files Browse the repository at this point in the history
## **Description**
- Add DS Guides link to component readmes

## **Related issues**

Fixes: #8149 

## **Manual testing steps**

1. Go to a component's readme 
2. Click on title
3.

## **Screenshots/Recordings**

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

### **Before**

<!-- [screenshots/recordings] -->

### **After**
<img width="660" alt="Screenshot 2024-01-25 at 8 51 23 AM"
src="https://github.com/MetaMask/metamask-mobile/assets/14355083/82cc44f4-d85f-4887-9306-4c9cd97c5236">
<img width="659" alt="Screenshot 2024-01-25 at 8 51 44 AM"
src="https://github.com/MetaMask/metamask-mobile/assets/14355083/161a3991-02e2-44d1-b847-ece4562d60cd">

<!-- [screenshots/recordings] -->

## **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
- [ ] 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".
- [ ] 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
brianacnguyen authored Feb 7, 2024
1 parent cc5e84e commit 34f9da1
Show file tree
Hide file tree
Showing 25 changed files with 27 additions and 26 deletions.
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
# Accordion
# [Accordion](https://metamask-consensys.notion.site/Accordion-f43e500b92754d9bb06bc72553c44494)

![Accordion](./Accordion.png)

Expand Down
2 changes: 1 addition & 1 deletion app/component-library/components/Avatars/Avatar/README.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
# Avatar
# [Avatar](https://metamask-consensys.notion.site/Avatar-3c55358131914c589ed1e6d21d14a04f)

![Avatar](./Avatar.png)

Expand Down
3 changes: 2 additions & 1 deletion app/component-library/components/Badges/Badge/README.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,7 @@
# Badge

[BadgeNetwork](https://metamask-consensys.notion.site/Badge-Network-94a679c50cb446f4844dc624b4f74946)
![BadgeNetwork](./variants/BadgeNetwork/BadgeNetwork.png)
[BadgeStatus](https://metamask-consensys.notion.site/Badge-Status-5caf000de32549f8ad67c0b89469ce4d)
![BadgeStatus](./variants/BadgeStatus/BadgeStatus.png)

Badge is a union component, which currently only consist of [BadgeNetwork](./variants/BadgeNetwork/BadgeNetwork.tsx)
Expand Down
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
# BadgeNetwork
# [BadgeNetwork](https://metamask-consensys.notion.site/Badge-Network-94a679c50cb446f4844dc624b4f74946)

![BadgeNetwork](./BadgeNetwork.png)

Expand Down
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
# BadgeStatus
# [BadgeStatus](https://metamask-consensys.notion.site/Badge-Status-5caf000de32549f8ad67c0b89469ce4d)

![BadgeStatus](./BadgeStatus.png)

Expand Down
3 changes: 2 additions & 1 deletion app/component-library/components/Banners/Banner/README.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,7 @@
# Banner

[BannerAlert](https://metamask-consensys.notion.site/Banner-Alert-56177453644641ed8ef5c96db6a7681f)
![BannerAlert](./variants/BannerAlert/BannerAlert.png)
[BannerTip](https://metamask-consensys.notion.site/Banner-Tip-67fdb01ab850472f90abc6f4127395cb)
![BannerTip](./variants/BannerTip/BannerTip.png)

This component is a union Banner component, which consists of [BannerAlert](../BannerAlert/BannerAlert.tsx) and [BannerTip](../BannerTip/BannerTip.tsx).
Expand Down
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
# BannerAlert
# [BannerAlert](https://metamask-consensys.notion.site/Banner-Alert-56177453644641ed8ef5c96db6a7681f)

![BannerAlert](./BannerAlert.png)

Expand Down
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
# BannerTip
# [BannerTip](https://metamask-consensys.notion.site/Banner-Tip-67fdb01ab850472f90abc6f4127395cb)

![BannerTip](./BannerTip.png)

Expand Down
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
# BottomSheet
# [BottomSheet](https://metamask-consensys.notion.site/Bottom-Sheet-302164aff8a74b6eb721f49586f88ecd)

![BottomSheet](./BottomSheet.png)

Expand Down
Original file line number Diff line number Diff line change
@@ -1,5 +1,4 @@
# BottomSheetFooter

# [BottomSheetFooter](https://metamask-consensys.notion.site/Footer-b0eacc3951bf4962b75f6c4f95a8c2df)
![BottomSheetFooter](./BottomSheetFooter.png)

BottomSheetFooter is a Footer component specifically used for BottomSheets.
Expand Down
2 changes: 1 addition & 1 deletion app/component-library/components/Buttons/Button/README.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
# Button
# [Button](https://metamask-consensys.notion.site/Button-88af1ddc075b40e3bb38a6d0c098d9b6)

![Button](./Button.png)

Expand Down
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
# ButtonIcon
# [ButtonIcon](https://metamask-consensys.notion.site/Button-Icon-52fa285ebd8b4d56a22b6eabd08a8cf0)

![ButtonIcon](./ButtonIcon.png)

Expand Down
2 changes: 1 addition & 1 deletion app/component-library/components/Checkbox/README.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
# Checkbox
# [Checkbox](https://metamask-consensys.notion.site/Checkbox-359c236367eb4058876fc12189c06824)

![Checkbox](./Checkbox.png)

Expand Down
2 changes: 1 addition & 1 deletion app/component-library/components/Form/HelpText/README.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
# HelpText
# [HelpText](https://metamask-consensys.notion.site/Help-Text-d3c5f6284df84d598e2c2d586083eef0)

![HelpText](./HelpText.png)

Expand Down
2 changes: 1 addition & 1 deletion app/component-library/components/Form/Label/README.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
# Label
# [Label](https://metamask-consensys.notion.site/Label-d6aa56ac40044195a5078d37d3118223)

![Label](./Label.png)

Expand Down
2 changes: 1 addition & 1 deletion app/component-library/components/Form/TextField/README.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
# TextField
# [TextField](https://metamask-consensys.notion.site/Text-Field-73e2b9b748404901ab2c9fba13eb7785)

![TextField](./TextField.png)

Expand Down
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
# TextFieldSearch
# [TextFieldSearch](https://metamask-consensys.notion.site/Text-Field-Search-de685317eeaf413f9682363128ffe673)

![TextFieldSearch](./TextFieldSearch.png)

Expand Down
2 changes: 1 addition & 1 deletion app/component-library/components/HeaderBase/README.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
# HeaderBase
# [HeaderBase](https://metamask-consensys.notion.site/Header-Base-2e96e1ac4c2b4816bb7bd3c594c72538)

![HeaderBase](./HeaderBase.png)

Expand Down
2 changes: 1 addition & 1 deletion app/component-library/components/Icons/Icon/README.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
# Icon
# [Icon](https://metamask-consensys.notion.site/Icon-140cbe6ea9044c189e75b795fef99dd6)

![Icon](./Icon.png)

Expand Down
2 changes: 1 addition & 1 deletion app/component-library/components/List/ListItem/README.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
# ListItem
# [ListItem](https://metamask-consensys.notion.site/List-Item-e3ddf0999a1844288b0a152e9d2a54b3)

![ListItem](./ListItem.png)

Expand Down
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
# ListItemMultiSelect
# [ListItemMultiSelect](https://metamask-consensys.notion.site/List-Item-MultiSelect-8ffafd9e99114e588c5c28ee5e4f0b10)

![ListItemMultiSelect](./ListItemMultiSelect.png)

Expand Down
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
# ListItemSelect
# [ListItemSelect](https://metamask-consensys.notion.site/List-Item-Select-e9173552eb1c4723b9549a021624c536)

![ListItemSelect](./ListItemSelect.png)

Expand Down
2 changes: 1 addition & 1 deletion app/component-library/components/RadioButton/README.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
# RadioButton
# [RadioButton](https://metamask-consensys.notion.site/Radio-Button-b1747843d5364be59185fed947f4a3a9)

![RadioButton](./RadioButton.png)

Expand Down
2 changes: 1 addition & 1 deletion app/component-library/components/Tags/Tag/README.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
# Tag
# [Tag](https://metamask-consensys.notion.site/Tag-da4bf064ab854b318b083febb978eb23)

![Tag](./Tag.png)

Expand Down
2 changes: 1 addition & 1 deletion app/component-library/components/Toast/README.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
# Toast
# [Toast](https://metamask-consensys.notion.site/Toast-0c8412d624174c47a20fb654f3001c26)

![Toast](./Toast.png)

Expand Down

0 comments on commit 34f9da1

Please sign in to comment.