Skip to content
This repository has been archived by the owner on Apr 26, 2024. It is now read-only.

Commit

Permalink
Add a table of contents to config manual (#12527)
Browse files Browse the repository at this point in the history

* Update config_documentation.md
  • Loading branch information
H-Shay authored Apr 25, 2022
1 parent 8a87b44 commit e75c7e3
Show file tree
Hide file tree
Showing 2 changed files with 46 additions and 2 deletions.
2 changes: 2 additions & 0 deletions changelog.d/12527.doc
Original file line number Diff line number Diff line change
@@ -0,0 +1,2 @@
Add an index to the configuration manual.

46 changes: 44 additions & 2 deletions docs/usage/configuration/config_documentation.md
Original file line number Diff line number Diff line change
Expand Up @@ -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.
Expand Down Expand Up @@ -3409,4 +3451,4 @@ background_updates:
sleep_duration_ms: 300
min_batch_size: 10
default_batch_size: 50
```
```

0 comments on commit e75c7e3

Please sign in to comment.