diff options
Diffstat (limited to 'doc/development/docstyleguide.txt')
| -rw-r--r-- | doc/development/docstyleguide.txt | 18 |
1 files changed, 12 insertions, 6 deletions
diff --git a/doc/development/docstyleguide.txt b/doc/development/docstyleguide.txt index 401a43bc0..fda1037f3 100644 --- a/doc/development/docstyleguide.txt +++ b/doc/development/docstyleguide.txt @@ -5,17 +5,23 @@ Documentation Style Guide for Bcfg2 =================================== -This is a style guide to use when creating documentation for Bcfg2. It is meant to be helpful, not a hinderence. +This is a style guide to use when creating documentation for Bcfg2. It +is meant to be helpful, not a hinderence. Basics ------ -:Bcfg2: +**Bcfg2** + When referring to project, Bcfg2 is the preferred use of cases. -:Monospace fonts: - When referring to commands written on the command line use monospace fonts. +**Monospace fonts** + + When referring to commands written on the command line use monospace + fonts. -:Repository: - When used alone this refers to a Bcfg2 :term:`repository`. When there is a chance for confusion, for instance in documents also talking about :term:`VCS`, be sure to use the longer Bcfg2 :term:`repository`. +**Repository** + When used alone this refers to a Bcfg2 :term:`repository`. When there + is a chance for confusion, for instance in documents also talking + about :term:`VCS`, be sure to use the longer Bcfg2 :term:`repository`. |