Browse Source

Add a table of contents to config manual (#12527)


* Update config_documentation.md
Shay 2 years ago
parent
commit
e75c7e3b6d
2 changed files with 46 additions and 2 deletions
  1. 2 0
      changelog.d/12527.doc
  2. 44 2
      docs/usage/configuration/config_documentation.md

+ 2 - 0
changelog.d/12527.doc

@@ -0,0 +1,2 @@
+Add an index to the configuration manual.
+

+ 44 - 2
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
   In addition, each setting has an example of its usage, with the proper indentation
   shown. 
   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
 ## Modules
 
 
 Server admins can expand Synapse's functionality with external modules.
 Server admins can expand Synapse's functionality with external modules.
@@ -3409,4 +3451,4 @@ background_updates:
     sleep_duration_ms: 300
     sleep_duration_ms: 300
     min_batch_size: 10
     min_batch_size: 10
     default_batch_size: 50
     default_batch_size: 50
-```
+```