large refactoring
This commit is contained in:
@@ -12,8 +12,8 @@ Si une dépendance demandée pose problème (erreur de compilation, bug, API man
|
||||
Quand une nouvelle construction (type, itérateur, abstraction) rend du code historique injustifié, le signaler immédiatement et proposer de le supprimer — ne pas conserver les deux en parallèle par inertie. Le développeur demande explicitement de remettre en cause le code base : ne pas attendre qu'il insiste.
|
||||
|
||||
Tu maintiens en **anglais**, dense et sans remplissage, les documents suivants :
|
||||
- `docmd/index.md` — document de discussion de base, enrichi progressivement au fil de nos échanges ; il reflète l'état courant de la réflexion sur le projet
|
||||
- les autres fichiers Markdown dans `docmd/` selon leur thème respectif
|
||||
- `DevDocMD/index.md` — document de discussion de base, enrichi progressivement au fil de nos échanges ; il reflète l'état courant de la réflexion sur le projet
|
||||
- les autres fichiers Markdown dans `DevDocMD/` selon leur thème respectif
|
||||
|
||||
Les snippets de code y sont courts et illustrent uniquement des principes architecturaux. Nos échanges se font en **français**.
|
||||
|
||||
@@ -42,33 +42,35 @@ Les snippets de code y sont courts et illustrent uniquement des principes archit
|
||||
|
||||
## Infrastructure de documentation
|
||||
|
||||
La documentation est gérée via **MkDocs + thème Material**, avec publication sur **GitHub Pages**.
|
||||
La documentation est gérée via **MkDocs + thème Material**, avec publication sur **GitHub Pages**. Deux arbres de documentation indépendants, deux configurations à la racine du dépôt (voir aussi `UserDocMD/` ci-dessous pour la doc utilisateur) :
|
||||
|
||||
**Structure des répertoires**
|
||||
|
||||
```
|
||||
docmd/ ← sources Markdown + mkdocs.yml
|
||||
docmd/mkdocs.yml
|
||||
doc/ ← site HTML généré (servi par GitHub Pages)
|
||||
DevDocMD/ ← sources Markdown, doc développeur (discussion, historique, rationale)
|
||||
UserDocMD/ ← sources Markdown, doc utilisateur (état factuel courant, sans code Rust)
|
||||
mkdocs.yml ← config doc développeur : docs_dir DevDocMD, site_dir DevDoc
|
||||
mkdocs-user.yml ← config doc utilisateur : docs_dir UserDocMD, site_dir doc
|
||||
DevDoc/ ← site HTML généré (doc développeur)
|
||||
doc/ ← site HTML généré (doc utilisateur — publié par GitHub Pages, répertoire par défaut)
|
||||
.venv/ ← environnement Python (ignoré par git)
|
||||
```
|
||||
|
||||
**Configuration `docmd/mkdocs.yml`**
|
||||
- `docs_dir: .` (sources = `docmd/` lui-même)
|
||||
- `site_dir: ../doc` (sortie = `doc/`)
|
||||
|
||||
**Commandes Makefile**
|
||||
|
||||
| Commande | Effet |
|
||||
|---|---|
|
||||
| `make doc` | Construit le HTML dans `doc/` |
|
||||
| `make doc-serve` | Serveur local avec rechargement automatique |
|
||||
| `make clean-doc` | Supprime `doc/` |
|
||||
| `make clean` | Supprime `doc/` et `.venv/` |
|
||||
| `make doc` | Construit la doc développeur dans `DevDoc/` |
|
||||
| `make doc-serve` | Serveur local (doc développeur), rechargement automatique |
|
||||
| `make clean-doc` | Supprime `DevDoc/` |
|
||||
| `make doc-user` | Construit la doc utilisateur dans `doc/` |
|
||||
| `make doc-user-serve` | Serveur local (doc utilisateur), rechargement automatique |
|
||||
| `make clean-doc-user` | Supprime `doc/` |
|
||||
| `make clean` | Supprime `DevDoc/`, `doc/` et `.venv/` |
|
||||
|
||||
Le `.venv/` est dans `.gitignore`. Le répertoire `doc/` (sortie HTML) est versionné pour GitHub Pages.
|
||||
Le `.venv/` est dans `.gitignore`. `DevDoc/` et `doc/` (sorties HTML) sont versionnés — `doc/` spécifiquement parce que c'est le répertoire par défaut que GitHub Pages sert.
|
||||
|
||||
Lors de l'ajout de nouveaux fichiers Markdown dans `docmd/`, mettre à jour la section `nav:` de `docmd/mkdocs.yml`.
|
||||
Lors de l'ajout de nouveaux fichiers Markdown dans `DevDocMD/`, mettre à jour la section `nav:` de `mkdocs.yml` ; dans `UserDocMD/`, mettre à jour `mkdocs-user.yml`.
|
||||
|
||||
---
|
||||
|
||||
|
||||
Reference in New Issue
Block a user