From ecb8f2e01471736590bc93d025c284164529e262 Mon Sep 17 00:00:00 2001 From: Tykayn Date: Mon, 28 Aug 2023 12:59:13 +0200 Subject: [PATCH] add doc to build faq --- README.md | 5 ++++- docs/index.md | 11 +++++++++++ docs/roadmap.md | 4 +++- 3 files changed, 18 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index 7b1c575..4857f1f 100644 --- a/README.md +++ b/README.md @@ -11,15 +11,18 @@ Module permettant d'intégrer une FAQ sur son site web. * [tests](docs/testing.md) * [traduction](docs/translate.md) + # Installation Pour installer les sous modules et les dépendances de dev permettant de construire la documentation, lancer la commande : + ```bash make ``` + # Contributions Voir les [directives de contribution](docs/contribute.md) -# composants +# Composants Ce module s'articule en trois parties: * api * example diff --git a/docs/index.md b/docs/index.md index 7cb3f13..fc84932 100644 --- a/docs/index.md +++ b/docs/index.md @@ -1,4 +1,15 @@ # Index de la documentation Grâce à la technologie [TeamBrain](https://teambrain.fr), vous bénéficiez de la puissance d’une FAQ dynamique auto-apprenante associée à l’interactivité du chatbot, les 2-en-1, sans code et sans prise de tête. +Parcourez les différentes sections pour en savoir d'avantage. +## Construction de la documentation +Fabriquée grâce à mkdocs et de simples fichiers en markdown +```bash +make doc +``` + +Pour voir ensuite le mini site construit: +```bash +mkdocs serve +``` diff --git a/docs/roadmap.md b/docs/roadmap.md index 5db04de..2bd10d2 100644 --- a/docs/roadmap.md +++ b/docs/roadmap.md @@ -1,4 +1,6 @@ # RoadMap -plan des prochaines réalisations +Plan des prochaines réalisations: * redirection vers une page 404 quand la FAQ demande une page inexistante + * configuration serveur + * routeur interne au coeur applicatif