From 59dabee37404403d16214d9086dcb79e66a94e02 Mon Sep 17 00:00:00 2001 From: Matt Fisher Date: Tue, 9 Jul 2024 11:34:17 -0600 Subject: [PATCH] Make the local documentation workflow more concise --- docs/contributing/index.md | 8 ++++---- 1 file changed, 4 insertions(+), 4 deletions(-) diff --git a/docs/contributing/index.md b/docs/contributing/index.md index 6a5abf5a..4df59b9b 100644 --- a/docs/contributing/index.md +++ b/docs/contributing/index.md @@ -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.