Kick start documentation guidelines

We need to determine the new guidelines for the documentation (writing style, format, etc..) and apply them in the documentation

ex:

• Title: define a title (with # ) for each page (or duplicate it from the {{title: .. }} tag)

• Warning and Info section: more visible and less confusing with the core text

• don’t use dot in filename

• …

A good documentation is a homogeneous documentation and we remove all of this with the migration

IMO:

• For this kickstart with should avoid to put everyone doing everything. Only one person in charge and manage it to bring discussion

• Once the guideline are etablished, then everybody can help to improve it

Francis recommandations :

• Don’t use dots in the directory name

• Do not put <h1> (#) in the page content, must start with <h2> (## XYZ)

• If you rename or move a page section, we should create a redirection from the old path to the new path (We need to avoid 404 pages from search engines)

• Images or files should be in /static/uc-doc/my-page/my-sub-page/

• Code blocks should have syntax defined ` ` ` ShellSession […] ` ` `

• Add an index.md in folder of content. Required to generate a clean navigation

When the guideline will be completed, we should update this page : https://wazo-platform.org/uc-doc/contributors/contributing_doc