README.md

dicehub-docs

This is the WIP branch of the brand new dicehub documentation at docs.dicehub.com. The content is under heavy updates and re-organization.

Public documentation for dicehub.

Development

This documentation uses mkdocs. To contribute to the documentation python 3 is required and the following steps have to be followed to setup the development environment:

1. Create virtual environment:

make venv

2. Activate virtual environment:

source .venv/bin/activate

3. Install python requirements:

make pip-install

4. Start mkdocs server:

mkdocs serve

Now open http://localhost:8000 and the rendered documentation should be visible.