Documentation Guideline

  1. Use docs-as-code.

  2. Prefer Markdown as markup language.

  3. Generate HTML and deploy it to GitHub Pages.

  4. Developer documentation is in english language.

  5. Provide an API documentation (JDoc, Doxgen, …).

  6. Provide a technical documentation to extend API documentation.