this_doc.md 802 Bytes
Newer Older
1
# About this documentation
2

3
## docsify.js
4

5
This markdown based documentation is made available in a nice way using [`docsify`](https://docsify.js.org/).
6

7
## Source
8

9
The source of the documentation is available in the `documentation` folder from the root of the repository.
10

11
## Rendering
12

13
The documentation is automatically rendered locally when you run the `make up` command. It is then available on [http://localhost:5000](http://localhost:5000).
14

15
To generate or update the UML diagrams, you need to run the command (from the root of the repository): `make documentation`.
16

17
## Issues ?
18

19
!> If the `search` functionality is not working after you have updated the documentation, it might be because the `localStorage` is not up to to data. You can empty it from your browser developer settings (`F12`).