blob: 45a746df8268cdaf0961536240e2a46878f3bf2d [file] [log] [blame]
John DeNisco06dcd452018-07-26 12:45:10 -04001.. _writingdocs:
2
3#########################
John DeNiscoce96dda2018-08-14 16:04:09 -04004Writing Documents
John DeNisco06dcd452018-07-26 12:45:10 -04005#########################
6
John DeNiscoc64ba6d2018-08-02 15:03:15 -04007This section covers the following topics:
8
9* Building VPP Documents
10* Merging FD.io VPP documents and performing a Git review
John DeNiscoc64ba6d2018-08-02 15:03:15 -040011* reStructured Text Style Guide that describes different format styles
12* Markdown Style Guide that describes different format styles
13
14
John DeNisco06dcd452018-07-26 12:45:10 -040015.. toctree::
John DeNisco758dc462018-08-13 17:00:06 -040016 :maxdepth: 3
John DeNisco06dcd452018-07-26 12:45:10 -040017
andrewdf50b452018-08-09 13:23:59 -040018 buildingrst
andrewdf50b452018-08-09 13:23:59 -040019 styleguide/index.rst
20 styleguidemd/index.rst