Merge pull request #1296 from geeksville/pr-fixinstructs

Update build instructions - pnpm is apparently now the tool used
This commit is contained in:
rcarteraz 2024-06-16 17:25:18 -07:00 committed by GitHub
commit 70638582bf
No known key found for this signature in database
GPG key ID: B5690EEEBB952194

View file

@ -48,21 +48,21 @@ Assuming you have the [prerequisites installed](/docs/development/documentation/
2. Install Dependencies
```shell title="Install dependencies using Yarn"
yarn install
```shell title="Install dependencies using pnpm"
pnpm i
```
3. Run Docusaurus
```shell title="Run node.js server"
yarn start
```shell title="Run a local documentation server and open it in your broswer"
pnpm run start
```
:::tip
Before submitting a pull request, it's helpful to run the following command to ensure there are no broken links or errors:
```shell title="Build Project"
yarn build
pnpm run build
```
:::