summary refs log tree commit diff
path: root/docs/implementation-notes/documentation_style.rst
diff options
context:
space:
mode:
authorKegan Dougal <kegan@matrix.org>2014-08-28 09:45:05 +0100
committerKegan Dougal <kegan@matrix.org>2014-08-28 09:45:05 +0100
commit660129deb1bb60dac04ff59d1da8bbe53882149e (patch)
tree79ca7c082e24e3039e75b3c0457cebd8a564f99a /docs/implementation-notes/documentation_style.rst
parentFix up the various presence-related tests so that if they're not skipped, the... (diff)
downloadsynapse-660129deb1bb60dac04ff59d1da8bbe53882149e.tar.xz
Shuffle files around in /docs
Diffstat (limited to 'docs/implementation-notes/documentation_style.rst')
-rw-r--r--docs/implementation-notes/documentation_style.rst43
1 files changed, 43 insertions, 0 deletions
diff --git a/docs/implementation-notes/documentation_style.rst b/docs/implementation-notes/documentation_style.rst
new file mode 100644
index 0000000000..c365d09dff
--- /dev/null
+++ b/docs/implementation-notes/documentation_style.rst
@@ -0,0 +1,43 @@
+===================
+Documentation Style
+===================
+
+A brief single sentence to describe what this file contains; in this case a
+description of the style to write documentation in.
+
+
+Sections
+========
+
+Each section should be separated from the others by two blank lines. Headings
+should be underlined using a row of equals signs (===). Paragraphs should be
+separated by a single blank line, and wrap to no further than 80 columns.
+
+[[TODO(username): if you want to leave some unanswered questions, notes for
+further consideration, or other kinds of comment, use a TODO section. Make sure
+to notate it with your name so we know who to ask about it!]]
+
+Subsections
+-----------
+
+If required, subsections can use a row of dashes to underline their header. A
+single blank line between subsections of a single section.
+
+
+Bullet Lists
+============
+
+ * Bullet lists can use asterisks with a single space either side.
+ 
+ * Another blank line between list elements.
+
+
+Definition Lists
+================
+
+Terms:
+  Start in the first column, ending with a colon
+
+Definitions:
+  Take a two space indent, following immediately from the term without a blank
+  line before it, but having a blank line afterwards.