(doc) reecriture de la doc en commençant par l'usage
This commit is contained in:
parent
cc16374a6b
commit
ea2a5a00a9
3 changed files with 77 additions and 0 deletions
49
doc/PriseEnMainRougail.md
Normal file
49
doc/PriseEnMainRougail.md
Normal file
|
|
@ -0,0 +1,49 @@
|
|||
---
|
||||
description: perception de l'outil par l'IA
|
||||
---
|
||||
|
||||
# Rougail vue par l'IA
|
||||
|
||||
## **question**
|
||||
|
||||
Est-ce que tu peux m'aider dans la prise en main de rougail ?
|
||||
https://rougail.readthedocs.io/en/stable/
|
||||
|
||||
---
|
||||
Oui, je peux vous aider à prendre en main Rougail ! D'après la documentation, Rougail est un outil qui permet de **charger des variables depuis des fichiers YAML** de manière pratique, tout en garantissant leur **cohérence** grâce à des règles que vous définissez.
|
||||
|
||||
Pour bien démarrer, voici une feuille de route structurée basée sur les sections clés que l'on trouve généralement dans ce type de documentation.
|
||||
|
||||
### 📚 Par où commencer ?
|
||||
La page d'accueil donne le ton, mais pour une prise en main efficace, je vous conseille de suivre ce parcours dans la documentation :
|
||||
|
||||
1. **Le tutoriel ("Tutorial")** : C'est le point de départ idéal. Il vous guidera pas à pas pour créer votre premier fichier de variables et appliquer des contraintes.
|
||||
2. **Les explications ("Explanation")** : Pour comprendre *pourquoi* Rougail fonctionne comme il le fait et la philosophie derrière l'outil.
|
||||
3. **Les guides pratiques ("How-to guides")** : Des recettes pour des cas concrets (ex: intégrer Rougail dans un projet existant).
|
||||
4. **La référence ("Reference")** : La documentation technique détaillée (format YAML, types de variables, etc.) à consulter au besoin.
|
||||
|
||||
### 💡 Ce que je peux faire pour vous concrètement
|
||||
Puisque je ne peux pas naviguer la documentation à votre place, je vous propose de m'envoyer des **extraits précis** de la documentation (un paragraphe, un exemple de code, une section qui vous semble floue) ou de me **décrire votre besoin** (ex: *"Je veux définir une variable qui doit être un nombre entre 1 et 10"*). Avec ces éléments, je pourrai :
|
||||
|
||||
* **Déchiffrer** la terminologie ou les concepts.
|
||||
* **Résumer** une section complexe.
|
||||
* **Donner des exemples** d'application concrets.
|
||||
* **Suggérer** des approches pour résoudre votre problème spécifique.
|
||||
|
||||
### 🚀 Pour commencer tout de suite
|
||||
Si vous voulez un premier exemple, voici ce que Rougail fait probablement (d'après la description) :
|
||||
|
||||
* **Sans Rougail** : Vous chargez un fichier `config.yml` et espérez que les valeurs soient correctes.
|
||||
* **Avec Rougail** : Vous définissez un *modèle* (par exemple, "la variable `port` doit être un entier entre 1024 et 65535"). Rougail charge le fichier, **valide** les valeurs par rapport à votre modèle, et vous donne un objet Python propre à utiliser, ou vous signale les erreurs.
|
||||
|
||||
N'hésitez pas à me soumettre le premier extrait qui vous pose question ou à me décrire votre premier cas d'usage, et nous avancerons ensemble !
|
||||
---
|
||||
|
||||
## Discussion
|
||||
|
||||
La seule imprécision ici est que :
|
||||
|
||||
Rougail "donne un objet Python propre à utiliser".
|
||||
|
||||
Rougail charge le fichier, valide les valeurs par rapport à votre modèle, et vous donne un objet Python propre à utiliser, ou vous signale les erreurs.
|
||||
|
||||
17
doc/PseudoPrompt.md
Normal file
17
doc/PseudoPrompt.md
Normal file
|
|
@ -0,0 +1,17 @@
|
|||
---
|
||||
description: conception de l'outil
|
||||
---
|
||||
## L'ensemble des outils lignes de commande
|
||||
|
||||
L'ensemble des outils ligne de commande est parfaitement cohérent,
|
||||
mais le ticket d'entrée (la prise en main) est difficile.
|
||||
Donc il s'agit ici de construire quelque chose de cohérent, d'intégré.
|
||||
|
||||
## lean architecture
|
||||
|
||||
La "lean architecture" (textual) est un outil de _Rapid Application Development_ framework. Cela évite d'avoir à envisager
|
||||
- un pseudo prompt ("terminal") dans le navigateur
|
||||
- des widgets qui se lancent depuis le prompt
|
||||
- la connexion asynchrone pour le prompt (textual le fait de base)
|
||||
- ...
|
||||
-
|
||||
11
doc/index.md
Normal file
11
doc/index.md
Normal file
|
|
@ -0,0 +1,11 @@
|
|||
L'important ici est la perception et la compréhension de l'outil.
|
||||
Il s'agit de faciliter l'usage de l'outil, OK.
|
||||
Mais quelle perception en a-t-on ?
|
||||
|
||||
## Perception de l'outil
|
||||
|
||||
[[PriseEnMainRougail]]
|
||||
|
||||
## l'IHM
|
||||
|
||||
[[PseudoPrompt]]
|
||||
Loading…
Reference in a new issue