Skip to content

Commit

Permalink
Update documentation
Browse files Browse the repository at this point in the history
  • Loading branch information
hocinehacherouf committed Dec 13, 2023
1 parent f2ec9c9 commit 2e6ea41
Showing 1 changed file with 4 additions and 11 deletions.
15 changes: 4 additions & 11 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,21 +1,14 @@
# IoT Hub Portal Documentation

[![Open in Gitpod](https://gitpod.io/button/open-in-gitpod.svg)](https://gitpod.io/#https://github.com/CGI-FR/IoT-Hub-Portal/tree/docs/main)

## Quick start

> The documentation of IoT Hub Portal is based on [https://squidfunk.github.io/mkdocs-material](mkdocs-material).
## Configure dev environment

To install mkdocs-material and required dependencies, you have to run the following command at the root of the project:

```console
pip install -r requirements.txt
```
To contribute to IoT Hub Portal's documentation:

After the installation python dependencies, your can start a local review of documentation site by the following command at the root of the project:
- Solution 1: Open this branch on Codespace
- Solutuion 2: Open this branch on a devcontainer using VS Code.

```console
mkdocs serve
```
On both solutions, a pre-configured development environment will be built, and the documentation website will be run and opened on an embedded browser.

0 comments on commit 2e6ea41

Please sign in to comment.