This style guide outlines the standards for contributing to the void-docs project. It is a work in progress.
This section details the specific format of the markdown files to use in the void-docs mdBook.
Each line should be less than 80 characters, unless there is special formatting that requires a longer line. Exceptions may include:
- links which start at the beginning of a new line
- code blocks
Headers shall only be in the ATX
heading format, and are only to be
used hierarchically (i.e do not skip from
First-level headers should be written in title case, meaning all words should be capitalized except for certain subsets. All other headers and should be written in sentence case, in which only the first word is capitalized. Proper nouns such as package names should have their case respected, regardless of the position in the header.
# The Quick Brown Fox Jumps Over The Lazy Dog ## The quick brown fox jumps over the lazy dog
Command code-blocks should start with a
$ character, indicating whether
the command should be run as
root or a regular user, respectively.
# xbps-install -Su
$ sudo xbps-install -Su
And also not:
Auto links (links with the same title as url) should use the following notation:
They should not be formatted like this:
Filenames and directories should use kebab
case when splitting words. For
example the filename should be
Words that are part of trademarks or well known package names are exempt from
this rule. Examples include
networkmanager which are well
known by their squashed names.
Prefer the active imperative voice when writing documentation. Consider the following examples:
Now we need to install the CUPS drivers and configure them.
This version is conversational and friendlier, but contains unnecessary language that may not be as clear to an ESL reader.
Install and configure the CUPS drivers, then configure them as shown.
This version contains a clear command to act, and a follow up that shows what will be done next. It is clear both to native English speakers, ESL readers, and to translators.