diff options
author | Raul Cuza <raulcuza@gmail.com> | 2010-03-13 16:41:36 -0500 |
---|---|---|
committer | Raul Cuza <raulcuza@gmail.com> | 2010-03-13 16:41:36 -0500 |
commit | 28279100a8148332f85ebdd7e708592af97af8f8 (patch) | |
tree | 3cf6ac19b00937a062b0bf25bcd2981abb1b3e03 /doc/development/docstyleguide.txt | |
parent | 8923eaf4461144aa227dd904c0a63a91349a54ec (diff) | |
download | bcfg2-28279100a8148332f85ebdd7e708592af97af8f8.tar.gz bcfg2-28279100a8148332f85ebdd7e708592af97af8f8.tar.bz2 bcfg2-28279100a8148332f85ebdd7e708592af97af8f8.zip |
Added styleguide to development section under the assumption that creating documentation is a part of development. :-)
Diffstat (limited to 'doc/development/docstyleguide.txt')
-rw-r--r-- | doc/development/docstyleguide.txt | 16 |
1 files changed, 16 insertions, 0 deletions
diff --git a/doc/development/docstyleguide.txt b/doc/development/docstyleguide.txt new file mode 100644 index 000000000..ef94bf232 --- /dev/null +++ b/doc/development/docstyleguide.txt @@ -0,0 +1,16 @@ +.. -*- mode: rst -*- + +.. _doc-styleguide: + +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. + +Basics +------ + +: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. |