Add/Update documentation

When reading this documentation your might have see some grammatical or spelling mistake you may want to correct.

Or when adding a new features, you will need to document it to be shown in this current documentation.

This tutorial will show you how update the documentation, how to check it locally and finally propose your modification.

Description

This documentation is generated using MkDocs, allowing to write the documentation in markdown format. All this documentations is located in the folder docs/ of the repo. The configuration of the documentation is done within a single file mkdocs.yml at the root of the repo.

Render the documentation

To render the documentation locally, you will need following dependencies:

• python3
• pip
• pipenv (optional)

The installation of pipenv is done using pip:

  pip install pipenv

Once pipenv is install, you can install the python virtual environment and activate it with the following commands:

# Assuming you are at the root of the repo
# Install the virtual environment
pipenv install
# Activate it
pipenv shell

Now, run the following commands:

mkdocs server

This will allow you to navigate through this documentation locally, with the following url http://localhost:8000.

Add/Update the documentation

Once the documentation is served, you can minimize the terminal which run the server of the documentation, as it will reload automatically the documentation when you will modify it. Which is convenient to see your modification in live.

Do all the modification of the documentation you need/want.

If you add new markdown files, do not forget to put them in the file mkdocs.yml otherwise they will still be rendered but they will not be shown on the left side of the documentation. And so not accessible unless other pages link to them.

Ready to publish

Once eveything is done, you can now prepare a merge request as described in :

• Developers Guidelines-6. Prepare your merge request.

And finally, you can propose your merge request as explain in :

• Developers Guidelines-7. Propose your merge request.