diff options
| author | Karen <karen@gitlab.com> | 2015-05-26 00:26:57 +0000 |
|---|---|---|
| committer | Karen <karen@gitlab.com> | 2015-05-26 00:26:57 +0000 |
| commit | 4e264076797316e0ae241f6e0c9bc18ad176587f (patch) | |
| tree | 751d20b8234c57a79abe04e1b1db223ba209770f /doc_styleguide.md | |
| parent | ef32c60a5417f5379a9af4a693dc4d31196cbe52 (diff) | |
| download | gitlab-ce-4e264076797316e0ae241f6e0c9bc18ad176587f.tar.gz | |
fixed info
Diffstat (limited to 'doc_styleguide.md')
| -rw-r--r-- | doc_styleguide.md | 6 |
1 files changed, 2 insertions, 4 deletions
diff --git a/doc_styleguide.md b/doc_styleguide.md index f047593f10b..670af765f3a 100644 --- a/doc_styleguide.md +++ b/doc_styleguide.md @@ -2,13 +2,11 @@ This styleguide recommends best practices to improve documentation and to keep it organized and easy to find. -## Text (when using markdown) +## Text * Make sure that the documentation is added in the correct directory and that there's a link to it somewhere useful. -* Add only one H1 or title, by adding '#' at the begining of it. - -* For subtitles, use '##', '###' and so on. +* Add only one H1 or title in each document, by adding '#' at the begining of it (when using markdown). For subtitles, use '##', '###' and so on. * Do not duplicate information. |