summary refs log tree commit diff
path: root/docs/README.md
diff options
context:
space:
mode:
Diffstat (limited to '')
-rw-r--r--docs/README.md12
1 files changed, 12 insertions, 0 deletions
diff --git a/docs/README.md b/docs/README.md

index 0b2b910c73..7802d3c3ce 100644 --- a/docs/README.md +++ b/docs/README.md
@@ -63,6 +63,18 @@ mdbook serve The URL at which the docs can be viewed at will be logged. +## Synapse configuration documentation + +The [Configuration +Manual](https://element-hq.github.io/synapse/latest/usage/configuration/config_documentation.html) +page is generated from a YAML file, +[schema/synapse-config.schema.yaml](../schema/synapse-config.schema.yaml). To +add new options or modify existing ones, first edit that file, then run +[scripts-dev/gen_config_documentation.py](../scripts-dev/gen_config_documentation.py) +to generate an updated Configuration Manual markdown file. + +Build the book as described above to preview it in a web browser. + ## Configuration and theming The look and behaviour of the website is configured by the [book.toml](../book.toml) file