diff options
| -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. |