Skip to content
Projects
Groups
Snippets
Help
Loading...
Help
Support
Keyboard shortcuts
?
Submit feedback
Contribute to GitLab
Sign in / Register
Toggle navigation
G
gitlab-ce
Project overview
Project overview
Details
Activity
Releases
Repository
Repository
Files
Commits
Branches
Tags
Contributors
Graph
Compare
Issues
0
Issues
0
List
Boards
Labels
Milestones
Merge Requests
0
Merge Requests
0
Analytics
Analytics
Repository
Value Stream
Wiki
Wiki
Snippets
Snippets
Members
Members
Collapse sidebar
Close sidebar
Activity
Graph
Create a new issue
Commits
Issue Boards
Open sidebar
Boxiang Sun
gitlab-ce
Commits
4e264076
Commit
4e264076
authored
May 26, 2015
by
Karen
Browse files
Options
Browse Files
Download
Email Patches
Plain Diff
fixed info
parent
ef32c60a
Changes
1
Hide whitespace changes
Inline
Side-by-side
Showing
1 changed file
with
2 additions
and
4 deletions
+2
-4
doc_styleguide.md
doc_styleguide.md
+2
-4
No files found.
doc_styleguide.md
View file @
4e264076
...
...
@@ -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.
...
...
Write
Preview
Markdown
is supported
0%
Try again
or
attach a new file
Attach a file
Cancel
You are about to add
0
people
to the discussion. Proceed with caution.
Finish editing this message first!
Cancel
Please
register
or
sign in
to comment