summaryrefslogtreecommitdiffstats
path: root/doc/docstyleguide.txt
blob: ef94bf232b337e9d571382baae61bd65155c1abf (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
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.