Compile and render Synapse's docs into a browsable, mobile-friendly and searchable website (#10086)

This commit is contained in:
Andrew Morgan 2021-06-03 17:20:40 +01:00 committed by GitHub
parent 9eea4646be
commit fd9856e4a9
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
35 changed files with 979 additions and 55 deletions

View file

@ -0,0 +1,12 @@
# Internal Documentation
This section covers implementation documentation for various parts of Synapse.
If a developer is planning to make a change to a feature of Synapse, it can be useful for
general documentation of how that feature is implemented to be available. This saves the
developer time in place of needing to understand how the feature works by reading the
code.
Documentation that would be more useful for the perspective of a system administrator,
rather than a developer who's intending to change to code, should instead be placed
under the Usage section of the documentation.