summary refs log tree commit diff
path: root/docs/development
diff options
context:
space:
mode:
authorRichard van der Hoff <richard@matrix.org>2021-06-04 10:41:36 +0100
committerRichard van der Hoff <richard@matrix.org>2021-06-04 10:41:36 +0100
commitf36457dce23b2a6c39715093dac03677af35c29a (patch)
treea641afcade2ba05606b67507dfbdf70a4dbf0fb1 /docs/development
parentMerge remote-tracking branch 'origin/develop' into matrix-org-hotfixes (diff)
parentLimit number of events in a replication request (#10118) (diff)
downloadsynapse-f36457dce23b2a6c39715093dac03677af35c29a.tar.xz
Merge remote-tracking branch 'origin/develop' into matrix-org-hotfixes
Diffstat (limited to 'docs/development')
-rw-r--r--docs/development/contributing_guide.md7
-rw-r--r--docs/development/internal_documentation/README.md12
2 files changed, 19 insertions, 0 deletions
diff --git a/docs/development/contributing_guide.md b/docs/development/contributing_guide.md
new file mode 100644

index 0000000000..ddf0887123 --- /dev/null +++ b/docs/development/contributing_guide.md
@@ -0,0 +1,7 @@ +<!-- + Include the contents of CONTRIBUTING.md from the project root (where GitHub likes it + to be) +--> +# Contributing + +{{#include ../../CONTRIBUTING.md}} diff --git a/docs/development/internal_documentation/README.md b/docs/development/internal_documentation/README.md new file mode 100644
index 0000000000..51c5fb94d5 --- /dev/null +++ b/docs/development/internal_documentation/README.md
@@ -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. \ No newline at end of file