We are using mkdocs to manage our documentation.
We're really happy if you want to contribute to make the documentation better! This is done by creating a pull request.
- Download, install dependencies
git clone --recursive https://github.com/waterlinked/docs
cd docs
virtualenv venv
source ven/bin/activate
pip install -r requirements.txt
mkdocs serve
-
Make changes using your favorite editor
-
Test them
- Fire up your browser and go to localhost:8000
After the changes have been tested and they work, push the changes to the master branch and Github will do the rest of the job for you!