diff options
author | Raul Cuza <raulcuza@gmail.com> | 2010-03-13 16:28:22 -0500 |
---|---|---|
committer | Raul Cuza <raulcuza@gmail.com> | 2010-03-13 16:28:22 -0500 |
commit | e86946fb6424beebae9d231018f4f540da8ca862 (patch) | |
tree | d9cb82fce7288904d214b0328f8fa3fbee1ef097 /doc/docstyleguide.txt | |
parent | b361b08d88456b5c53a0ef38b1ac0da26660a87a (diff) | |
download | bcfg2-e86946fb6424beebae9d231018f4f540da8ca862.tar.gz bcfg2-e86946fb6424beebae9d231018f4f540da8ca862.tar.bz2 bcfg2-e86946fb6424beebae9d231018f4f540da8ca862.zip |
Adding a style guide. This can be a reference for helping create consistency in the documentation. Modify it as you see fit.
Diffstat (limited to 'doc/docstyleguide.txt')
-rw-r--r-- | doc/docstyleguide.txt | 16 |
1 files changed, 16 insertions, 0 deletions
diff --git a/doc/docstyleguide.txt b/doc/docstyleguide.txt new file mode 100644 index 000000000..ef94bf232 --- /dev/null +++ b/doc/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. |