-
Notifications
You must be signed in to change notification settings - Fork 1
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Signed-off-by: Dusan Borovcanin <[email protected]>
- Loading branch information
1 parent
a5dc6e9
commit b3c0e81
Showing
1 changed file
with
8 additions
and
8 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,16 +1,16 @@ | ||
| # Magistrala | ||
| # SuperMQ | ||
|
|
||
| [![license][license]](LICENSE) | ||
| [build][build] | ||
| [](https://github.com/absmach/magistrala-docs/actions/workflows/pages.yaml) | ||
| [](https://github.com/absmach/supermq-docs/actions/workflows/pages.yaml) | ||
|
|
||
| This repo collects the collaborative work on Magistrala documentation. | ||
| The official documentation is hosted at [Magistrala Docs page][docs]. | ||
| This repo collects the collaborative work on SuperMQ documentation. | ||
| The official documentation is hosted at [SuperMQ Docs page][docs]. | ||
| Documentation is auto-generated from Markdown files in this repo. | ||
|
|
||
| [MkDocs](https://www.mkdocs.org/) 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][blog]. | ||
| > Additional practical information about SuperMQ system, news and tutorials can be found on the [SuperMQ blog][blog]. | ||
| ## Prerequisites | ||
|
|
||
|
|
@@ -25,7 +25,7 @@ pip install mkdocs | |
| Doc repo can be fetched from GitHub: | ||
|
|
||
| ```bash | ||
| git clone [email protected]:/absmach/magistrala-docs.git | ||
| git clone [email protected]:/absmach/supermq-docs.git | ||
| ``` | ||
|
|
||
| ## Usage | ||
|
|
@@ -40,9 +40,9 @@ 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! | ||
| Thank you for your interest in SuperMQ and the desire to contribute! | ||
|
|
||
| 1. Take a look at our [open issues](https://github.com/absmach/magistrala-docs/issues). The [good-first-issue](https://github.com/absmach/magistrala-docs/labels/good-first-issue) label is specifically for issues that are great for getting started. | ||
| 1. Take a look at our [open issues](https://github.com/absmach/supermq-docs/issues). The [good-first-issue](https://github.com/absmach/supermq-docs/labels/good-first-issue) label is specifically for issues that are great for getting started. | ||
| 2. Check out the [contribution guide](CONTRIBUTING.md) to learn more about our style and conventions. | ||
| 3. Make your changes compatible with our workflow. | ||
|
|
||
|
|
||