aboutsummaryrefslogtreecommitdiffstats
path: root/docs/gettingstarted/writingdocs/index.rst
diff options
context:
space:
mode:
authorJohn DeNisco <jdenisco@cisco.com>2018-08-02 15:03:15 -0400
committerNeale Ranns <nranns@cisco.com>2018-08-03 09:07:18 +0000
commitc64ba6dc6ab9e3b06feac1a86c2f59d7052609ce (patch)
tree7102af8eaebcf4d9296eb3c5519a5b72ed62a417 /docs/gettingstarted/writingdocs/index.rst
parent5c482a9de3b28a5609b1c2029d1c2dc12466109c (diff)
docs: Incororate Scott's overall review
Change-Id: Ic70a62e17891fa9291a5274400ae89f1d6194b6e Signed-off-by: John DeNisco <jdenisco@cisco.com>
Diffstat (limited to 'docs/gettingstarted/writingdocs/index.rst')
-rw-r--r--docs/gettingstarted/writingdocs/index.rst12
1 files changed, 9 insertions, 3 deletions
diff --git a/docs/gettingstarted/writingdocs/index.rst b/docs/gettingstarted/writingdocs/index.rst
index e1ce767e40e..1361c422af7 100644
--- a/docs/gettingstarted/writingdocs/index.rst
+++ b/docs/gettingstarted/writingdocs/index.rst
@@ -4,6 +4,15 @@
Writing VPP Documentation
#########################
+This section covers the following topics:
+
+* Building VPP Documents
+* Merging FD.io VPP documents and performing a Git review
+* Using Read the Docs
+* reStructured Text Style Guide that describes different format styles
+* Markdown Style Guide that describes different format styles
+
+
.. toctree::
buildingrst
@@ -13,6 +22,3 @@ Writing VPP Documentation
styleguidemd/index.rst
todo
pushingapatch
-
-
-