Magistrala

[build][build]

This repo collects the collaborative work on Magistrala documentation. The official documentation is hosted at Magistrala 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 Magistrala system, news and tutorials can be found on the Magistrala blog.

Prerequisites

Install MkDocs

pip install mkdocs

Install

Doc repo can be fetched from GitHub:

git clone [email protected]:/absmach/magistrala-docs.git

Usage

Use MkDocs to serve documentation:

mkdocs serve

Then just point the browser to http://127.0.0.1:8000.

Contributing

Thank you for your interest in Magistrala and the desire to contribute!

1. Take a look at our open issues. The good-first-issue label is specifically for issues that are great for getting started.
2. Check out the contribution guide to learn more about our style and conventions.
3. Make your changes compatible with our workflow.

Community

• Matrix
• Twitter

License

Apache-2.0