diff options
Diffstat (limited to 'docs/gettingstarted/writingdocs')
4 files changed, 5 insertions, 5 deletions
diff --git a/docs/gettingstarted/writingdocs/styleguide/index.rst b/docs/gettingstarted/writingdocs/styleguide/index.rst index 443476f83b6..240b3a26b19 100644 --- a/docs/gettingstarted/writingdocs/styleguide/index.rst +++ b/docs/gettingstarted/writingdocs/styleguide/index.rst @@ -10,7 +10,7 @@ the Sphinx Markup Constructs used in these documents. The Sphinx style guide can For a more detailed list of Sphinx Markup Constructs please refer to: `Sphinx Markup Constructs <http://www.sphinx-doc.org/en/stable/markup/index.html>`_ -This document is also an example of a directory structure for a document that spans mutliple pages. +This document is also an example of a directory structure for a document that spans multiple pages. Notice we have the file **index.rst** and the then documents that are referenced in index.rst. The referenced documents are shown at the bottom of this page. diff --git a/docs/gettingstarted/writingdocs/styleguide/styleguide02.rst b/docs/gettingstarted/writingdocs/styleguide/styleguide02.rst index e2d7649f585..af92c93c316 100644 --- a/docs/gettingstarted/writingdocs/styleguide/styleguide02.rst +++ b/docs/gettingstarted/writingdocs/styleguide/styleguide02.rst @@ -16,7 +16,7 @@ Bold text can be show with **Bold Text**, Italics with *Italic text*. Bullets li Notes ***** -A note can be used to describe something not in the normal flow of the paragragh. This +A note can be used to describe something not in the normal flow of the paragraph. This is an example of a note. .. note:: @@ -28,7 +28,7 @@ is an example of a note. Code Blocks *********** -This paragraph describes how to do **Console Commands**. When showing VPP commands it is reccomended +This paragraph describes how to do **Console Commands**. When showing VPP commands it is recommended that the command be executed from the linux console as shown. The Highlighting in the final documents shows up nicely this way. diff --git a/docs/gettingstarted/writingdocs/styleguide/styleguide04.rst b/docs/gettingstarted/writingdocs/styleguide/styleguide04.rst index 1bc4210de78..7dcea37d9d3 100644 --- a/docs/gettingstarted/writingdocs/styleguide/styleguide04.rst +++ b/docs/gettingstarted/writingdocs/styleguide/styleguide04.rst @@ -4,7 +4,7 @@ Including a file **************** -A complete file should be included with the following construct. It is recomended it be included with +A complete file should be included with the following construct. It is recommended it be included with it's own .rst file describing the file included. This is an example of an xml file is included. .. toctree:: diff --git a/docs/gettingstarted/writingdocs/styleguidemd/styleguide02.md b/docs/gettingstarted/writingdocs/styleguidemd/styleguide02.md index b297d328082..5582d7224c9 100644 --- a/docs/gettingstarted/writingdocs/styleguidemd/styleguide02.md +++ b/docs/gettingstarted/writingdocs/styleguidemd/styleguide02.md @@ -11,7 +11,7 @@ Code Blocks =========== This paragraph describes how to do **Console Commands**. When showing -VPP commands it is reccomended that the command be executed from the +VPP commands it is recommended that the command be executed from the linux console as shown. The Highlighting in the final documents shows up nicely this way. |