summary refs log tree commit diff
path: root/docs/development
diff options
context:
space:
mode:
authorAndrew Morgan <1342360+anoadragon453@users.noreply.github.com>2021-06-03 17:20:40 +0100
committerGitHub <noreply@github.com>2021-06-03 17:20:40 +0100
commitfd9856e4a98fb3fa9c139317b0a3b79f22aff1c7 (patch)
treec9aeec6486e6f169dd8db5fbd692a0fff36bacdb /docs/development
parentAdd OpenTracing for database activity. (#10113) (diff)
downloadsynapse-fd9856e4a98fb3fa9c139317b0a3b79f22aff1c7.tar.xz
Compile and render Synapse's docs into a browsable, mobile-friendly and searchable website (#10086)
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