Prior to reading this you should have read about commenting code at the "Code Standards" page. This page explains how to do the "official" documentation that lives outside the source.
Where
In order to have a good reference for other users to follow, the software has
to be documented outside of the source files. To do this we use a combination
of markdown (the document format used here, consider it a fancy .txt
) and
GitLabs own services to generate the html pages that you are looking at now.
These pages are not part of the source, instead they are located in the related wiki repository. This makes it easier to require updated documentation along with code changes, and make sure they change at the same time. Additionally, the changes made to the wiki are under proper version control.
When you code, you should write the appropriate documentation and submit those changes along with the code.
General guidelines
Exactly how we are going to organize documentation has not been discussed yet. In the meantime, apply common sense. Try to follow the existing structure that you see in the table of contents.