summary refs log tree commit diff
path: root/docs/implementation-notes/documentation_style.rst
diff options
context:
space:
mode:
authorErik Johnston <erik@matrix.org>2014-10-17 20:18:02 +0100
committerErik Johnston <erik@matrix.org>2014-10-17 20:18:02 +0100
commita065becea5c57ce0f2f6654187b3aef02013c139 (patch)
tree425362827f2dc8e9f43f72f23de9445cc75a99f4 /docs/implementation-notes/documentation_style.rst
parentkeep 'origin_server_ts' as 'ts' in the database to avoid needlessly updating ... (diff)
parentmove swagger JSON from synapse project to matrix-doc project (diff)
downloadsynapse-a065becea5c57ce0f2f6654187b3aef02013c139.tar.xz
Merge branch 'docs-restructuring' of github.com:matrix-org/synapse into develop
Diffstat (limited to 'docs/implementation-notes/documentation_style.rst')
-rw-r--r--docs/implementation-notes/documentation_style.rst43
1 files changed, 0 insertions, 43 deletions
diff --git a/docs/implementation-notes/documentation_style.rst b/docs/implementation-notes/documentation_style.rst
deleted file mode 100644

index c365d09dff..0000000000 --- a/docs/implementation-notes/documentation_style.rst +++ /dev/null
@@ -1,43 +0,0 @@ -=================== -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.