kotovalexarian-likes-gitlab/gitlab-org--gitlab-foss
1
0
Fork 0
Code Releases Activity

fixed info

Browse source
This commit is contained in:
Karen 2015-05-26 00:26:57 +00:00
parent ef32c60a54
commit 4e26407679
1 changed files with 2 additions and 4 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

6
doc_styleguide.md
View file

@ -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.