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

Commit 2e72f16

Browse files
authored
docs: fixed yarn instructions and copy/paste to be correct (#116)
* docs: fixed copy/paste text to be correct The docs have "$" signs for prompts which unfortunately get copied as part of the command (when you hover over the text and press the Copy button). For almost all users, this wouldn't be the desired behavior (i.e. you don't want the $ as part of the command you paste). Tiny change, hope it helps someone. * fix: updated documentation for yarn correctness Two things: - Updated all references to `yarn` to omit the `$` so that on-hover Copy doesn't include the $ - Updated README to have correct info. IIUC, folks outside Shopify don't have the "dev" command, and should instead use yarn. Also, the instructions for "yarn serve" were incorrect; for local live-serves, you should use `yarn start`. * docs: twiddle something to retrigger build steps
1 parent e2fdf62 commit 2e72f16

6 files changed

Lines changed: 13 additions & 13 deletions

File tree

docs/README.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -9,17 +9,17 @@ This website is built using [Docusaurus 2](https://docusaurus.io/) and is publis
99
Note: make sure you are in the `documentation` folder prior to performing the commands below
1010

1111
```bash
12-
dev up # installs the dependencies
13-
dev server # builds the website and serves it locally
14-
dev open # opens the website on a browser
12+
yarn install # installs the dependencies
13+
yarn start # builds and serves the local content
1514
```
1615

1716
You should then have a local development server up and running and the website open in browser window. Most changes are reflected live without having to restart the server.
1817

1918
## Build
2019

2120
```bash
22-
dev build # builds a production version of the website
21+
yarn build # builds a production version of the website
22+
yarn serve # Serves from the "build" directory
2323
```
2424

2525
This command generates static content into the `build` directory and serves it locally for testing.

docs/docs/fundamentals/getting-started.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -9,13 +9,13 @@ slug: /fundamentals/getting-started
99
You can install the package by running the following command:
1010

1111
```bash
12-
$ yarn add @shopify/react-native-performance
12+
yarn add @shopify/react-native-performance
1313
```
1414

1515
Since this package contains code that needs to be natively linked, you'll have to run pod install:
1616

1717
```bash
18-
$ npx pod-install
18+
npx pod-install
1919
```
2020

2121
## Usage

docs/docs/guides/react-native-performance-lists-profiler.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -14,7 +14,7 @@ This library contains components for profiling [`FlatList`](https://reactnative.
1414
You can install the package by running the following command:
1515

1616
```bash
17-
$ yarn add @shopify/react-native-performance-lists-profiler react-native-flipper
17+
yarn add @shopify/react-native-performance-lists-profiler react-native-flipper
1818
```
1919

2020
## ListsProfiler

docs/docs/guides/react-native-performance-navigation/getting-started.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -24,13 +24,13 @@ Note that there are additional helper packages to be used with the [React Naviga
2424
You can install the package by running the following command:
2525

2626
```bash
27-
$ yarn add @shopify/react-native-performance-navigation
27+
yarn add @shopify/react-native-performance-navigation
2828
```
2929

3030
Note that this package has the following peer dependencies that should be listed in your app's package.json:
3131

3232
```bash
33-
$ yarn add @react-navigation/core @react-navigation/stack @react-navigation/native @shopify/react-native-performance
33+
yarn add @react-navigation/core @react-navigation/stack @react-navigation/native @shopify/react-native-performance
3434
```
3535

3636
### ReactNavigationPerformanceView

docs/docs/guides/react-native-performance-navigation/react-native-performance-navigation-bottom-tabs.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -13,13 +13,13 @@ Extension library atop [@shopify/react-native-performance-navigation](../react-n
1313
You can install the package by running the following command:
1414

1515
```bash
16-
$ yarn add @shopify/react-native-performance-navigation-bottom-tabs
16+
yarn add @shopify/react-native-performance-navigation-bottom-tabs
1717
```
1818

1919
Note that this package has the following peer dependencies that should be listed in your app's package.json:
2020

2121
```bash
22-
$ yarn add @react-navigation/core @react-navigation/stack @react-navigation/native @react-navigation/bottom-tabs @shopify/react-native-performance @shopify/react-native-performance-navigation
22+
yarn add @react-navigation/core @react-navigation/stack @react-navigation/native @react-navigation/bottom-tabs @shopify/react-native-performance @shopify/react-native-performance-navigation
2323
```
2424

2525
## Usage

docs/docs/guides/react-native-performance-navigation/react-native-performance-navigation-drawer.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -13,13 +13,13 @@ Extension library atop [@shopify/react-native-performance-navigation](../react-n
1313
You can install the package by running the following command:
1414

1515
```bash
16-
$ yarn add @shopify/react-native-performance-navigation-drawer
16+
yarn add @shopify/react-native-performance-navigation-drawer
1717
```
1818

1919
Note that this package has the following peer dependencies that should be listed in your app's package.json:
2020

2121
```bash
22-
$ yarn add @react-navigation/core @react-navigation/stack @react-navigation/native @react-navigation/drawer-tabs @shopify/react-native-performance @shopify/react-native-performance-navigation react-native-reanimated react-native-gesture-handler
22+
yarn add @react-navigation/core @react-navigation/stack @react-navigation/native @react-navigation/drawer-tabs @shopify/react-native-performance @shopify/react-native-performance-navigation react-native-reanimated react-native-gesture-handler
2323
```
2424

2525
## Usage

0 commit comments

Comments
 (0)