organise content by subject

This commit is contained in:
Job van der Voort 2017-12-21 13:31:41 +00:00
parent 3ee5fd156e
commit 007e51f128
1 changed files with 4 additions and 0 deletions

View File

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