Merge pull request loco-rs#758 from isaacdonaldson/documentation/add_…

…zola_to_contributing.md Add doc site running instructions to CONTRIBUTING.md
billy1624 · Sep 19, 2024 · 883be95 · 883be95
2 parents 9a0e0af + 2470659
commit 883be95
Showing 1 changed file with 5 additions and 0 deletions.
diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md
@@ -78,6 +78,11 @@ Updating the Documentation
 + Create the snippet in the [yaml file](./snipdoc.yml) or inline the code.
 + Run `snipdoc run`.
 
+To run the documentation site locally, we use [zola](https://www.getzola.org/) so you'll need to [install](https://www.getzola.org/documentation/getting-started/installation/) it. The documentation site works with zola version `0.19.2` and since zola still has breaking changes, we make no guarantees about other versions.
+
+Running the local preview
++ `cd docs-site`
++ `npm run serve` or `zola serve`
 
 ## Open A Pull Request