Skip to content

Commit 7106721

Browse files
authored
feat(doc): fix typo for examples folder
1 parent 015c681 commit 7106721

File tree

1 file changed

+6
-5
lines changed

1 file changed

+6
-5
lines changed

contributing.md

Lines changed: 6 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -14,28 +14,29 @@ cd react-notion-x
1414
yarn
1515
```
1616

17-
This will install dependencies and link all of the local packages together using `lerna`. This includes the `example` projects which will now point to the local version of your packages.
17+
This will install dependencies and link all of the local packages together using `lerna`. This includes the `examples` projects which will now point to the local version of your packages.
1818

1919
```bash
2020
yarn dev
2121
```
2222

2323
This starts compiling the packages into their respective `build` folders. Under the hood, it is running `tsc --watch` and `tsup --watch`, so every time you make a change to one of the packages, the build will be updated automatically as long as this command is running.
2424

25-
With `yarn dev` running in one tab, we recommend opening a second tab and navigating to the `example/minimal` directory.
25+
With `yarn dev` running in one tab, we recommend opening a second tab and navigating to the `examples/minimal` directory.
2626

2727
```bash
28-
cd example/minimal
28+
cd examples/minimal
2929
yarn dev
3030
```
3131

32-
Running `yarn dev` from the `example/minimal` directory will start the example project's Next.js dev server. This project should be using your locally built version of the libraries because they have been linked using `lerna`.
32+
Running `yarn dev` from the `examples/minimal` directory will start the example project's Next.js dev server. This project should be using your locally built version of the libraries because they have been linked using `lerna`.
3333

3434
You should now be able to open `http://localhost:3000` to view and debug the example project.
3535

3636
### Gotchas
3737

38-
Whenever you make a change to one of the packages, the `yarn dev` from the project root will re-compile that package, and the `yarn dev` from the example project's Next.js dev server should hot-reload it in the browser.
38+
Whenever you make a change to one of the packages, the `yarn dev` from the project root will re-compile that package, and the `yarn dev` from the
39+
project's Next.js dev server should hot-reload it in the browser.
3940

4041
Sometimes, this process gets a little out of whack, and if you're not sure what's going on, I usually just quit one or both of the `yarn dev` commands and restart them.
4142

0 commit comments

Comments
 (0)