summary refs log tree commit diff
path: root/docs/README.md
diff options
context:
space:
mode:
authorShay <hillerys@element.io>2021-11-19 14:01:55 -0800
committerGitHub <noreply@github.com>2021-11-19 14:01:55 -0800
commitd9e9771d6b5a92d2eb0b98b7b6437b25c5ec314e (patch)
tree34100cdd00f7b6cbd198d0e95b8d2760caca4614 /docs/README.md
parentAdd an admin API to run background jobs. (#11352) (diff)
downloadsynapse-d9e9771d6b5a92d2eb0b98b7b6437b25c5ec314e.tar.xz
Update README.md
Diffstat (limited to '')
-rw-r--r--docs/README.md6
1 files changed, 4 insertions, 2 deletions
diff --git a/docs/README.md b/docs/README.md
index 6d70f5afff..5222ee5f03 100644
--- a/docs/README.md
+++ b/docs/README.md
@@ -50,8 +50,10 @@ build the documentation with:
 mdbook build
 ```
 
-The rendered contents will be outputted to a new `book/` directory at the root of the repository. You can
-browse the book by opening `book/index.html` in a web browser.
+The rendered contents will be outputted to a new `book/` directory at the root of the repository. Please note that 
+index.html is not built by default, it is created by copying over the file `welcome_and_overview.html` to `index.html`
+during deployment. Thus, when running `mdbook serve` locally the book will initially show a 404 in place of the index
+due to the above. Do not be alarmed!
 
 You can also have mdbook host the docs on a local webserver with hot-reload functionality via: