From 54ed5c4be942f30bea08633ca23ccbf4e7395285 Mon Sep 17 00:00:00 2001 From: Sophie Lathouwers Date: Thu, 6 Mar 2025 09:30:59 +0100 Subject: [PATCH] Update documentation for local docs website testing As we're using docusaurus, you can locally generate the website files and/or test the site locally. However, this depends on Node.js and several packages. The README didn't indicate that you needed to install the dependencies. This has now been added. --- docs/README.md | 7 ++++++- 1 file changed, 6 insertions(+), 1 deletion(-) diff --git a/docs/README.md b/docs/README.md index 490e94b34..e08772c35 100644 --- a/docs/README.md +++ b/docs/README.md @@ -9,6 +9,11 @@ The documentation can be found in the `docs/` directory. Required: - [Node.js](https://nodejs.org/en/download/) version 18.0 or above: - When installing Node.js, you are recommended to check all checkboxes related to dependencies. + +If you want to use the commands below and this is your first time running/generating the website locally, you'll need to run the following command to install the dependencies: +```bash +npm install +``` ### Generate website files To statically generate the website, within this directory (`knowledge-engine/docs/`), run: @@ -31,4 +36,4 @@ npm run start ``` The `npm run start` command builds your website locally and serves it through a development server, ready for you to view at http://localhost:3000/. -The site will **automatically reload** and display your changes. \ No newline at end of file +The site will **automatically reload** and display your changes.