From e75c7e3b6ddc25b76b4eabf10eca1e923048ae43 Mon Sep 17 00:00:00 2001 From: Shay Date: Mon, 25 Apr 2022 11:43:59 -0700 Subject: [PATCH] Add a table of contents to config manual (#12527) * Update config_documentation.md --- changelog.d/12527.doc | 2 + .../configuration/config_documentation.md | 46 ++++++++++++++++++- 2 files changed, 46 insertions(+), 2 deletions(-) create mode 100644 changelog.d/12527.doc diff --git a/changelog.d/12527.doc b/changelog.d/12527.doc new file mode 100644 index 000000000..e6907321e --- /dev/null +++ b/changelog.d/12527.doc @@ -0,0 +1,2 @@ +Add an index to the configuration manual. + diff --git a/docs/usage/configuration/config_documentation.md b/docs/usage/configuration/config_documentation.md index 9c864af6e..968b0fbfa 100644 --- a/docs/usage/configuration/config_documentation.md +++ b/docs/usage/configuration/config_documentation.md @@ -64,7 +64,49 @@ apply if you want your config file to be read properly. A few helpful things to In addition, each setting has an example of its usage, with the proper indentation shown. - +## Contents +[Modules](#modules) + +[Server](#server) + +[Homeserver Blocking](#homeserver-blocking) + +[TLS](#tls) + +[Federation](#federation) + +[Caching](#caching) + +[Database](#database) + +[Logging](#logging) + +[Ratelimiting](#ratelimiting) + +[Media Store](#media-store) + +[Captcha](#captcha) + +[TURN](#turn) + +[Registration](#registration) + +[API Configuration](#api-configuration) + +[Signing Keys](#signing-keys) + +[Single Sign On Integration](#single-sign-on-integration) + +[Push](#push) + +[Rooms](#rooms) + +[Opentracing](#opentracing) + +[Workers](#workers) + +[Background Updates](#background-updates) + ## Modules Server admins can expand Synapse's functionality with external modules. @@ -3409,4 +3451,4 @@ background_updates: sleep_duration_ms: 300 min_batch_size: 10 default_batch_size: 50 -``` \ No newline at end of file +```