Skip to content

Commit

Permalink
Make the local documentation workflow more concise
Browse files Browse the repository at this point in the history
  • Loading branch information
mfisher87 authored Jul 9, 2024
1 parent b62b5dd commit 59dabee
Showing 1 changed file with 4 additions and 4 deletions.
8 changes: 4 additions & 4 deletions docs/contributing/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -52,11 +52,11 @@ To ensure that our code is well-documented and easy to understand, we use [Googl

#### Locally rendering the documentation

To work on documentation locally, follow these steps:
To work on documentation locally, we provide a script that will automatically re-render the docs when you make changes:

- To setup the documentation, navigate to the scripts directory
- Run the `scripts/build-docs.sh` script to build the documentation
- Serve the documentation locally, using the `scripts/docs-live.sh` script
```
./scripts/docs-live.sh
```

If you encounter any issues while setting up the documentation using the provided steps, please refer to our [tutorial]( https://www.youtube.com/watch?v=mNjlMZ4F3So) for additional guidance.

Expand Down

0 comments on commit 59dabee

Please sign in to comment.