From e86946fb6424beebae9d231018f4f540da8ca862 Mon Sep 17 00:00:00 2001 From: Raul Cuza Date: Sat, 13 Mar 2010 16:28:22 -0500 Subject: Adding a style guide. This can be a reference for helping create consistency in the documentation. Modify it as you see fit. --- doc/docstyleguide.txt | 16 ++++++++++++++++ 1 file changed, 16 insertions(+) create mode 100644 doc/docstyleguide.txt (limited to 'doc') 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. -- cgit v1.2.3-1-g7c22