Skip to content
Snippets Groups Projects
Commit 73762344 authored by Yi Ding's avatar Yi Ding
Browse files

add something about contributing to the docs

parent 07c5aeba
No related branches found
No related tags found
No related merge requests found
...@@ -62,3 +62,17 @@ To install packages for every package or application run ...@@ -62,3 +62,17 @@ To install packages for every package or application run
``` ```
pnpm add -w [NPM Package] pnpm add -w [NPM Package]
``` ```
### Docs
To contribute to the docs, go to the docs website folder and run the Docusaurus instance.
```bash
cd apps/docs
pnpm install
pnpm start
```
That should start a webserver which will serve the docs on https://localhost:3000
Any changes you make should be reflected in the browser. If you need to regenerate the API docs and find that your TSDoc isn't getting the updates, feel free to remove apps/docs/api. It will automatically regenerate itself when you run pnpm start again.
0% Loading or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment