From e4d5726deeb5132e616b717e5cefb70e13c0c046 Mon Sep 17 00:00:00 2001
From: Deepak Khatri <lorforlinux@beagleboard.org>
Date: Fri, 16 Sep 2022 19:59:57 +0530
Subject: [PATCH] Init rst cheatsheet
---
intro/contribution/index.rst | 1 +
intro/contribution/rst-cheat-sheet.rst | 42 ++++++++++++++++++++++++++
2 files changed, 43 insertions(+)
create mode 100644 intro/contribution/rst-cheat-sheet.rst
diff --git a/intro/contribution/index.rst b/intro/contribution/index.rst
index 642543c0..b1ac606d 100644
--- a/intro/contribution/index.rst
+++ b/intro/contribution/index.rst
@@ -88,3 +88,4 @@ Style and usage guidelines
/intro/contribution/git-usage
/intro/contribution/style
+ /intro/contribution/rst-cheat-sheet
diff --git a/intro/contribution/rst-cheat-sheet.rst b/intro/contribution/rst-cheat-sheet.rst
new file mode 100644
index 00000000..3abc3222
--- /dev/null
+++ b/intro/contribution/rst-cheat-sheet.rst
@@ -0,0 +1,42 @@
+.. _rst-cheat-sheet:
+
+ReStructuredText Cheat Sheet
+############################
+
+BeagleBoard docs is mostly writted with ReStructuredText (r)
+
+Headings
+*********
+
+For each document we divide sections with headings and in ReStructuredText we can use
+matching overline and underline to indicate a heading.
+
+1. Document heading (H1) use ``#``.
+2. First heading (H2) use ``*``.
+3. First heading (H2) use ``=``.
+4. First heading (H2) use ``-``.
+5. First heading (H2) use ``~``.
+
+.. note::
+ You can include only one (H1) ``#`` in a single documentation page.
+
+Make sure the length of your heading symbol is atleast (or
+more) the lenth of the heading text, for example:
+
+
+.. callout::
+
+ .. code-block:: ReStructuredText
+
+ incorrect H1
+ ##### # <1>
+
+ correct H1
+ ############ # <2>
+
+ .. annotations::
+
+ <1> length of heading sybol ``#`` is smaller than the content above.
+ <2> Shows the correct way of setting the document title (H1) with ``#``.
+
+
\ No newline at end of file
--
GitLab