This repo collects the collaborative work on Mainflux documentation. Official documentation is hosted at Mainflux Read The Docs page. Documentation is auto-generated from Markdown files in this repo.
MkDocs is used to serve the docs locally with different theming.
Additional practical information about Mainflux system, news and tutorials can be found on the Mainflux blog.
Install MkDocs
pip install mkdocs
Doc repo can be fetched from GitHub:
git clone [email protected]:mainflux/docs.gitUse MkDocs to serve documentation:
mkdocs serveThen just point the browser to http://127.0.0.1:8000.
Thank you for your interest in Mainflux and the desire to contribute!
- Take a look at our open issues. The good-first-issue label is specifically for issues that are great for getting started.
- Checkout the contribution guide to learn more about our style and conventions.
- Make your changes compatible to our workflow.