summaryrefslogtreecommitdiffstats
path: root/docs/gettingstarted/writingdocs/index.rst
blob: 89245ef28d19250cb720a7fbefdec4748efa44e5 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
.. _writingdocs:

#########################
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::
   :maxdepth: 2

   buildingrst
   gitreview
   readthedocs
   styleguide/index.rst
   styleguidemd/index.rst
   todo
   pushingapatch