README.md

User documentation guidlines

The user documentation is

• stored in /docs folder,
• written in Markdown following the GitHub Flavored Markdown specification,
• rendered by mkdocs-material,
• published on docs.dev.wopee.io (from autonomous-testing/docs repo) and on docs.wopee.io (from autonomous-testing/docs-prod repo) using GitHub Pages.

Images used in documentation are

• stored in /docs/img folder,
• foldered by name of markdown file where image is used.

Remeber to add redirects to original pages into mkdocs.yml when changing pages structure.

Local development

To preview the documentation locally, you can use the following command:

make serve