From 007e51f12814ac836b47e649ca78f9b5b53e3dc7 Mon Sep 17 00:00:00 2001 From: Job van der Voort Date: Thu, 21 Dec 2017 13:31:41 +0000 Subject: [PATCH] organise content by subject --- doc/development/doc_styleguide.md | 4 ++++ 1 file changed, 4 insertions(+) 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 |