Created guidelines for documentation contributors.

This commit is contained in:
Axon 2015-05-26 14:13:07 +00:00
parent 53d8295fc3
commit 79e40cc24d
No known key found for this signature in database
GPG Key ID: 8CE137352A019A17
2 changed files with 25 additions and 0 deletions

24
DocStyle.md Normal file
View File

@ -0,0 +1,24 @@
---
layout: doc
title: DocStyle
permalink: /doc/DocStyle/
redirect_from: /wiki/DocStyle/
---
Guidelines for Documentation Contributors
=========================================
* Use spaces instead of tabs.
* Hard wrap Markdown lines at 80 characters.
* Hard wrap Git commit message lines at 72 characters.
* This leaves exactly four spaces on each side of the commit message when
viewed in the default `git log` format.)
* If appropriate, make numerals in numbered lists match between Markdown source
and HTML output.
* In the event that a user is required to read the Markdown
source directly, this will make it easier to follow, e.g., numbered steps in
a set of instructions.
* Use hanging indentations
where appropriate.
* Use `[reference-style][ref]` links.
`[ref]: http://daringfireball.net/projects/markdown/syntax#link`

View File

@ -30,6 +30,7 @@ For Developers
- [How can I contribute to the Qubes project?](/doc/ContributingHowto/)
- [Source Code](/doc/SourceCode/)
- [Coding Guidelines](/doc/CodingStyle/)
- [Documentation Guidelines](/doc/DocStyle/)
- [Books for Developers](/doc/DevelBooks/)
- [Research Papers](/doc/QubesResearch/)
- [Architecture](/doc/QubesArchitecture/)