Contributing to the documentation

The documentation is written in markdown and then generated with mkdocs. Required libraries are installed if you've followed the development environment documentation of the project.

Graphs and diagrams are generated by the Mermaid library.

Update the documentation in the docs folder placed in the root of the project.

Run dev server locally to check the result

mkdocs serve

The page is available on http://127.0.0.1:8000.

Send a pull request then to propose your changes to the project.