Skip to content

Commit c923ade

Browse files
committed
update contrib docs
1 parent 7819066 commit c923ade

File tree

1 file changed

+4
-2
lines changed

1 file changed

+4
-2
lines changed

Diff for: CONTRIBUTING.md

+4-2
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,7 @@ We use npm scripts for building, testing, and linting. Read the scripts to beco
77
```
88
npm install
99
npm run build
10-
npm run test
10+
npm run test-local
1111
npm run lint-fix
1212
```
1313

@@ -21,7 +21,7 @@ compiled code in `dist`.
2121

2222
## Documentation
2323

24-
Documentation is written in markdown in `website/docs` and rendered into a website by Docusaurus.
24+
Documentation is written in markdown in `website/docs` and rendered into a website by Docusaurus. The README is also generated from these markdown files.
2525

2626
To edit documentation, modify the markdown files in `./website/docs` and the sidebar declaration in `./website/sidebars.js`
2727

@@ -36,6 +36,8 @@ cd ./website
3636
yarn
3737
yarn start
3838
# Will host live website locally
39+
40+
yarn build-readme # will rebuild the README.md
3941
```
4042

4143
This site was used to generate the favicon from a high-res PNG export of the SVG. https://realfavicongenerator.net/

0 commit comments

Comments
 (0)