summaryrefslogtreecommitdiff
path: root/doc/development/doc_styleguide.md
diff options
context:
space:
mode:
authorConstance Okoghenun <cokoghenun@gitlab.com>2018-01-09 00:50:54 +0100
committerConstance Okoghenun <cokoghenun@gitlab.com>2018-01-09 00:50:54 +0100
commit85e8acedaf1d4e51335c59a0efa2f95576a4fde3 (patch)
tree9b21d76626568158cf746e2a7eb4853efe3aa0d5 /doc/development/doc_styleguide.md
parentcdcade0dd4e748bcf0119b307c06993e0669f507 (diff)
parentbd50ecbad8c00e7c9ab5c60fa8bc839a8905b4ab (diff)
downloadgitlab-ce-move-project-dropdown.tar.gz
Resolved conflictsmove-project-dropdown
Diffstat (limited to 'doc/development/doc_styleguide.md')
-rw-r--r--doc/development/doc_styleguide.md4
1 files changed, 4 insertions, 0 deletions
diff --git a/doc/development/doc_styleguide.md b/doc/development/doc_styleguide.md
index db13e0e6249..9cb1f708a6a 100644
--- a/doc/development/doc_styleguide.md
+++ b/doc/development/doc_styleguide.md
@@ -18,6 +18,10 @@ like `docs.gitlab.com/user/project/merge_requests.html`. With this pattern,
you can immediately tell that you are navigating a user related documentation
and is about the project and its merge requests.
+Do not create summaries of similar types of content (e.g. an index of all articles, videos, etc.),
+rather organise content by its subject (e.g. everything related to CI goes together)
+and cross-link between any related content.
+
The table below shows what kind of documentation goes where.
| Directory | What belongs here |