From 2e6ea41bd1a57e26c1947ffd5b99c1b5ce3ca7b6 Mon Sep 17 00:00:00 2001 From: hocine hacherouf Date: Wed, 13 Dec 2023 22:08:37 +0000 Subject: [PATCH] Update documentation --- README.md | 15 ++++----------- 1 file changed, 4 insertions(+), 11 deletions(-) diff --git a/README.md b/README.md index ce952d5ea..99976875d 100644 --- a/README.md +++ b/README.md @@ -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.