From d4a059b9fa7fb593d6f6fb434bedbd40717c2fe7 Mon Sep 17 00:00:00 2001 From: John Collinson <13622412+johncollinson2001@users.noreply.github.com> Date: Mon, 7 Oct 2024 19:56:02 +0100 Subject: [PATCH] Update docs info in README. --- README.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index 46b7e16..e6cdf44 100644 --- a/README.md +++ b/README.md @@ -52,7 +52,7 @@ The repository consists of the following directories: ## Documentation -The documentation is built and served as a static site using dockerised [MkDocs](https://www.mkdocs.org/). +The documentation in markdown format resides in [`./docs`](./docs/index.md). It can also be built and served as a static site using [MkDocs](https://www.mkdocs.org/). To build and run the docs locally, install Docker then run the following command from the root of the repository: @@ -60,7 +60,7 @@ To build and run the docs locally, install Docker then run the following command docker-compose -f ./docs/docker-compose.yml up ``` -Once the container is running, navigate to [http://localhost:8000](http://localhost:8000) to access the docs. +Once the container is running, navigate to [http://localhost:8000](http://localhost:8000). ## Contributing