add docs/README.md

This commit is contained in:
Aine 2024-11-29 16:58:30 +02:00
parent 392fec3186
commit 14d1c904c0
No known key found for this signature in database
GPG key ID: 34969C908CCA2804

30
docs/README.md Normal file
View file

@ -0,0 +1,30 @@
# Documentation
Synapse Admin documentation is under construction right now, so PRs are greatly appreciated!
Table of contents:
<!-- vim-markdown-toc GFM -->
* [Configuration](#configuration)
* [Features](#features)
* [Deployment](#deployment)
<!-- vim-markdown-toc -->
## Configuration
[Full configuration documentation](./config.md)
Specific configuration options:
* [Restricting available homeserver](./restrict-hs.md)
* [System / Appservice-managed Users](./system-users.md)
* [Custom Menu Items](./custom-menu.md)
## Features
* [User Badges](./user-badges.md)
## Deployment
* [Serving Synapse Admin behind a reverse proxy](./reverse-proxy.md)