tykayn
/
teambrain
1
0
Fork 0
Code Issues Pull Requests Projects Releases Wiki Activity

add doc to build faq

This commit is contained in:
Tykayn 2023-08-28 12:59:13 +02:00 committed by tykayn
parent ed966a9b98
commit ecb8f2e014
3 changed files with 18 additions and 2 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

5
README.md
View File

@ -11,15 +11,18 @@ Module permettant d'intégrer une FAQ sur son site web.
* [tests](docs/testing.md) * [tests](docs/testing.md)
* [traduction](docs/translate.md) * [traduction](docs/translate.md)
# Installation # Installation
Pour installer les sous modules et les dépendances de dev permettant de construire la documentation, lancer la commande : Pour installer les sous modules et les dépendances de dev permettant de construire la documentation, lancer la commande :
```bash ```bash
make make
``` ```
# Contributions # Contributions
Voir les [directives de contribution](docs/contribute.md) Voir les [directives de contribution](docs/contribute.md)
# composants # Composants
Ce module s'articule en trois parties: Ce module s'articule en trois parties:
* api * api
* example * example

11
docs/index.md
View File

@ -1,4 +1,15 @@
# Index de la documentation # 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. 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
```

4
docs/roadmap.md
View File

@ -1,4 +1,6 @@
# RoadMap # RoadMap
plan des prochaines réalisations Plan des prochaines réalisations:
* redirection vers une page 404 quand la FAQ demande une page inexistante * redirection vers une page 404 quand la FAQ demande une page inexistante
* configuration serveur
* routeur interne au coeur applicatif