summaryrefslogtreecommitdiff
path: root/doc_styleguide.md
diff options
context:
space:
mode:
authorAchilleas Pipinellis <axilleas@axilleas.me>2016-01-12 11:47:08 +0100
committerAchilleas Pipinellis <axilleas@axilleas.me>2016-01-12 11:57:42 +0100
commitd0b2d278f4fc7c929bd19ce9f29eb689783f58ed (patch)
treedbff04ffcfbe21579b37470604e574e623dd8801 /doc_styleguide.md
parent587f850170a38e2642c0de76fb69efdeae930d66 (diff)
downloadgitlab-ce-d0b2d278f4fc7c929bd19ce9f29eb689783f58ed.tar.gz
Move doc_styleguide in the development directory
[ci skip]
Diffstat (limited to 'doc_styleguide.md')
-rw-r--r--doc_styleguide.md25
1 files changed, 1 insertions, 24 deletions
diff --git a/doc_styleguide.md b/doc_styleguide.md
index cceb449a854..05ff46323ac 100644
--- a/doc_styleguide.md
+++ b/doc_styleguide.md
@@ -1,26 +1,3 @@
# Documentation styleguide
-This styleguide recommends best practices to improve documentation and to keep it organized and easy to find.
-
-## Text
-
-- Split up long lines, this makes it much easier to review and edit. Only
-double line breaks are shown as a full line break in markdown. 80 characters
-is a good line length.
-- For subtitles, make sure to start with the largest and go down, meaning:
-`#` for the title, `##` for subtitles and `###` for subtitles of the subtitles, etc.
-- 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 in each document, by adding '#' at the begining of it (when using markdown).
-For subtitles, use '##', '###' and so on.
-- Do not duplicate information.
-- Be brief and clear.
-- Whenever it applies, add documents in alphabetical order.
-- Write in US English
-- Use [single spaces](http://www.slate.com/articles/technology/technology/2011/01/space_invaders.html) instead of double spaces.
-
-## Images
-
-- Create a directory to store the images with the specific name of the document where the images belong.
-It could be in the same directory where the .md document that you're working on is located.
-- Images should have a specific, non-generic name that will differentiate them.
-- Keep all file names in lower case. \ No newline at end of file
+Moved to [development/doc_styleguide](doc/development/doc_styleguide.md).