1
0

Add some section pages

These pages simply act as a container for other pages, but also serve to provide
an introduction and explanation for the pages to come. We can also use it to
describe what topics should be covered in the section, to help others organise
new documentation pages.
This commit is contained in:
Andrew Morgan
2021-05-26 02:06:33 +01:00
parent 1e029761ba
commit bee8edc7f0
14 changed files with 117 additions and 8 deletions

View File

@@ -0,0 +1,5 @@
# Development
This section covers topics related to development of Synapse. This includes explanations
of how different parts of Synapse are implemented, as well as guidance on the tooling
that Synapse developers regularly use.

View File

@@ -0,0 +1,7 @@
<!--
Include the contents of CONTRIBUTING.md from the project root (where Github likes it
to be)
-->
# Contributing
{{#include ../../CONTRIBUTING.md}}

View File

@@ -0,0 +1,12 @@
# Feature Documentation
This section covers implementation documentation for various features 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 sysadmin, rather than
a developer who's intended to change to code, should instead be placed in
[Usage](../../usage/).