summaryrefslogtreecommitdiff
path: root/docs/contributing/documentation.rst
diff options
context:
space:
mode:
authorChristian Poessinger <christian@poessinger.com>2019-11-24 21:23:58 +0100
committerGitHub <noreply@github.com>2019-11-24 21:23:58 +0100
commit6adb039393ab70334ed6512c3e630c0de7a60404 (patch)
treeff4f68af63409f205c206bf3f6481b2db5629571 /docs/contributing/documentation.rst
parent46fa911c528d58567c721ee1b510d48f584e7de0 (diff)
parent26a6ef51fade0ba738582eedc4e64169e9c62f89 (diff)
downloadvyos-documentation-6adb039393ab70334ed6512c3e630c0de7a60404.tar.gz
vyos-documentation-6adb039393ab70334ed6512c3e630c0de7a60404.zip
Merge pull request #149 from rebortg/sections
Add Section to style guide and fix TOC
Diffstat (limited to 'docs/contributing/documentation.rst')
-rw-r--r--docs/contributing/documentation.rst27
1 files changed, 27 insertions, 0 deletions
diff --git a/docs/contributing/documentation.rst b/docs/contributing/documentation.rst
index 3f088455..c89be9d4 100644
--- a/docs/contributing/documentation.rst
+++ b/docs/contributing/documentation.rst
@@ -83,6 +83,33 @@ This requires you already have a GitHub account.
Style Guide
-----------
+Sections
+^^^^^^^^
+
+We use the following syntax for Headlines.
+
+.. code-block:: sh
+
+ #####
+ Parts
+ #####
+
+ ********
+ Chapters
+ ********
+
+ Sections
+ ========
+
+ Subsections
+ -----------
+
+ Subsubsections
+ ^^^^^^^^^^^^^^
+
+ Paragraphs
+ """"""""""
+
Address space
^^^^^^^^^^^^^