docs: 📝 améliorer la typographie, ajouter doc générique et architecture consolidée

Author: Vincent Scharpen (Darkiron)

README.md

@@ -10,9 +10,11 @@ What’s inside:
 This repository is structured as a monorepo and includes a Docker Compose setup for local development.
 
 ## Quick links 🔗
-- 📚 Documentation index: docs/README.md
-- 🗂️ In-repo Wiki index: docs/wiki/Home.md
-- 🔗 GitHub Wiki (published): https://github.com/darkiron/huginn/wiki
+- 📚 Documentation index : docs/README.md
+- 🗂️ Wiki (dans le dépôt) : docs/wiki/Home.md
+- 🏗️ Architecture consolidée : docs/architecture.md
+- 🧭 Documentation générale : docs/wiki/Documentation-Generique.md
+- 🔗 GitHub Wiki (publié) : https://github.com/darkiron/huginn/wiki
 
 ## Getting started (Docker) 🐳
 1. Prérequis : Docker Desktop 4.x ou plus récent.

docs/README.md

@@ -15,3 +15,11 @@ This folder contains the source of truth for project documentation. It is mirror
 - troubleshooting.md — Common issues and fixes
 
 Tip : See docs/wiki/Home.md for the wiki version. 🔗
+
+
+## Style typographique (FR) ✍️
+- Utiliser des espaces insécables fines avant : « : », « ; », « ! », « ? ».
+- Préférer les guillemets français « … » et l’apostrophe typographique ’.
+- Garder des titres courts, ajouter des emojis avec mesure 😄.
+
+Voir aussi : docs/wiki/Documentation-Generique.md.

docs/architecture.md

@@ -1,23 +1,52 @@
-# Architecture 🏗️
+# Architecture consolidée 🏗️✨
 
-## Overview
-- 🌐 Frontend (Laravel) serves the user interface and talks to the Symfony backend.
-- 🧱 Backend (Symfony) provides API endpoints, orchestrates domain logic, and delegates LLM‑related work to the Python service when needed.
-- 🧠 LLM Service (Python) encapsulates model logic and streaming/generation features.
-- 🐳 Docker Compose wires services together for local development.
+Cette page présente une vue d’ensemble consolidée de l’architecture de Huginn, les flux de données et les points d’intégration clés. Elle est conçue pour être générique et durable, indépendamment des implémentations ponctuelles. 
 
-## High‑level data flow 🔄
-1. The user interacts with the Laravel frontend.
-2. The frontend calls Symfony backend APIs.
-3. The backend applies domain rules and, if needed, requests completions/streams from the Python LLM service.
-4. Responses propagate back to the frontend. ✅
+## Panorama des composants 🧩
+- 🌐 Frontend (Laravel) — Fournit l’interface utilisateur et consomme l’API backend.
+- 🧱 Backend (Symfony) — Expose des endpoints, applique la logique métier et orchestre les services.
+- 🧠 Service LLM (Python) — Encapsule la génération et le streaming, expose des métriques Prometheus.
+- 🐳 Docker Compose — Relie et configure les services pour le dev local.
 
-## Repositories and code of interest 📁
-- apps/laravel-front — Laravel controllers, routes, views.
-- apps/symfony-back — Symfony controllers, domain models, use cases.
+## Diagramme (Mermaid) 🗺️
+```mermaid
+flowchart LR
+  subgraph UI[UI / Frontend (Laravel)]
+    A[Client Web]
+  end
+  subgraph API[API / Backend (Symfony)]
+    B[Contrôleurs
+    + Cas d'usage]
+  end
+  subgraph LLM[Service LLM (Python)]
+    C[HTTP generate/stream
+    + CLI RNN]
+    M[Metrics :9108 /metrics]
+  end
+  A -->|HTTP| B
+  B -->|HTTP POST /generate/stream| C
+  C -->|stream| B
+  B -->|JSON| A
+  M -.->|Prometheus scrape| Ext[(Observabilité)]
+```
+
+## Flux de données 🔄
+1. L’utilisateur interagit avec le Frontend (Laravel).
+2. Le Frontend appelle l’API du Backend (Symfony).
+3. Le Backend applique la logique métier et délègue au Service LLM (Python) si nécessaire (génération/streaming).
+4. Les réponses remontent vers le Frontend. ✅
+
+## Points d’intégration clés 🔌
+- URL LLM par défaut : `http://llm:8008/generate/stream` (configurable via `LLM_URL`).
+- Métriques : `http://localhost:9108/metrics` exposé par le conteneur LLM.
+- Volumes : `./ckpts -> /ckpts` (checkpoints), `./apps/python-llm -> /app/apps/python-llm`.
+
+## Répertoires et fichiers utiles 📁
+- apps/laravel-front — contrôleurs, routes, vues.
+- apps/symfony-back — contrôleurs, domaine, cas d’usage.
   - src/Domain/Model/Prompt.php
   - src/Domain/Port/LLMGateway.php
   - src/Application/UseCase/GenerateStreamUseCase.php
   - src/Controller/LLMController.php
-- apps/python-llm — Python LLM components (llm_rnn and more).
+- apps/python-llm — composants LLM (llm_rnn, tokenizers, etc.).
 

docs/wiki/Architecture.md

@@ -1,6 +1,41 @@
-# Architecture 🏗️
+# Architecture consolidée 🏗️✨
 
-See also repository docs : ../architecture.md 🔗
+Cette page reprend la vue d’ensemble consolidée de l’architecture de Huginn. Pour la version « source », voir aussi ../architecture.md 🔗.
 
-- 🌐 Frontend (Laravel) → 🧱 Backend (Symfony) → 🧠 LLM Service (Python)
-- Data flow and responsibilities are outlined in the repo docs.
+## Panorama des composants 🧩
+- 🌐 Frontend (Laravel) — Interface utilisateur consommant l’API backend.
+- 🧱 Backend (Symfony) — Endpoints, logique métier, orchestration des services.
+- 🧠 Service LLM (Python) — Génération/streaming, métriques Prometheus.
+- 🐳 Docker Compose — Assemblage local des services.
+
+## Diagramme (Mermaid) 🗺️
+```mermaid
+flowchart LR
+  subgraph UI[UI / Frontend (Laravel)]
+    A[Client Web]
+  end
+  subgraph API[API / Backend (Symfony)]
+    B[Contrôleurs
+    + Cas d'usage]
+  end
+  subgraph LLM[Service LLM (Python)]
+    C[HTTP generate/stream
+    + CLI RNN]
+    M[Metrics :9108 /metrics]
+  end
+  A -->|HTTP| B
+  B -->|HTTP POST /generate/stream| C
+  C -->|stream| B
+  B -->|JSON| A
+  M -.->|Prometheus scrape| Ext[(Observabilité)]
+```
+
+## Flux de données 🔄
+1. L’utilisateur interagit avec le Frontend (Laravel).
+2. Le Frontend appelle l’API du Backend (Symfony).
+3. Le Backend délègue au Service LLM (Python) si nécessaire (génération/streaming).
+4. Les réponses remontent vers le Frontend. ✅
+
+## Liens utiles 🔗
+- Endpoint LLM par défaut : http://llm:8008/generate/stream
+- Métriques : http://localhost:9108/metrics

docs/wiki/Documentation-Generique.md

@@ -0,0 +1,46 @@
+# Documentation générale 🧭📚
+
+Cette page rassemble des informations génériques et transverses utiles à tous les contributeurs et utilisateurs. Elle met l’accent sur la clarté, la typographie, et les points d’entrée communs. ✨
+
+## Principes de base ✅
+- Simplicité d’abord : expliquer le nécessaire, lier le reste.
+- Cohérence : mêmes noms, mêmes chemins, mêmes options.
+- Emojis avec parcimonie 😄 : pour signaler les sections et les alertes.
+
+## Typographie (FR) ✍️
+- Espaces insécables fines avant : « : », « ; », « ! », « ? ». Exemple : « Docker : démarrer… ».
+- Guillemets français « … » pour les citations, apostrophe typographique ’ si possible.
+- Tirez le meilleur des tirets : tiret court « - » pour les listes, tiret moyen « – » pour les incises.
+
+Astuce : dans Markdown, collez une espace fine insécable (U+202F) avant « : ; ! ? » lorsque vous éditez depuis un éditeur compatible.
+
+## Endpoints et services 🔌
+- Backend (Symfony) : sert l’API HTTP.
+- Service LLM (Python) :
+  - Génération HTTP attendue par le backend : `http://llm:8008/generate/stream`
+  - Métriques Prometheus : `http://localhost:9108/metrics`
+
+Voir aussi :
+- [Architecture](Architecture.md) — Vue consolidée et diagramme Mermaid 🗺️
+- [LLM RNN CLI](LLM-RNN-CLI.md) — Génération via Docker Compose 🐳
+
+## Développement local 🛠️
+- Démarrage rapide : `docker compose up -d`
+- Frontend : http://localhost:8080 (ou 8081 selon compose)
+- Backend : http://localhost:8000
+- LLM (metrics) : http://localhost:9108/metrics
+
+Consultez aussi :
+- [Setup](Setup.md) — Installation et commandes utiles
+- [Environment](Environment.md) — Variables d’environnement et secrets
+
+## Conventions de commit 🧾
+- Utiliser Conventional Commits : `feat:`, `fix:`, `docs:`, etc.
+- Ajouter un gitemoji au besoin : `docs: 📝 …`, `ci: 🤖 …`, `feat: ✨ …`.
+
+## Qualité et liens 🔗
+- Utiliser des liens relatifs entre pages wiki.
+- Préférer des titres courts et descriptifs.
+- Éviter les redondances : lier les pages d’autorité (source of truth).
+
+Bonnes contributions ! 🤝

docs/wiki/Home.md

@@ -3,12 +3,13 @@
 Bienvenue ! Cette documentation vous guide à travers l’architecture, l’installation et l’exploitation de Huginn. ✨
 
 ## Pages 🧭
-- [Architecture](Architecture.md) — High‑level design and data flow
-- [Setup](Setup.md) — Local development and Docker quickstart
-- [Environment](Environment.md) — Environment variables and secrets handling
-- [Backend-Symfony](Backend-Symfony.md) — Symfony backend notes
-- [Frontend-Laravel](Frontend-Laravel.md) — Laravel frontend notes
-- [LLM-Service-Python](LLM-Service-Python.md) — Python LLM service notes
-- [LLM RNN CLI](LLM-RNN-CLI.md) — Generate text via docker compose exec and llm_rnn.generate
-- [Ops-Deployment](Ops-Deployment.md) — Deployment considerations
-- [Troubleshooting](Troubleshooting.md) — Common issues and fixes
+- [Architecture](Architecture.md) — Conception globale et flux de données
+- [Setup](Setup.md) — Démarrage local et Docker
+- [Documentation générique](Documentation-Generique.md) — Conventions, styles, API et CLI
+- [Environment](Environment.md) — Variables d’environnement et gestion des secrets
+- [Backend-Symfony](Backend-Symfony.md) — Notes backend Symfony
+- [Frontend-Laravel](Frontend-Laravel.md) — Notes frontend Laravel
+- [LLM-Service-Python](LLM-Service-Python.md) — Notes sur le service Python LLM
+- [LLM RNN CLI](LLM-RNN-CLI.md) — Générer du texte via docker compose exec et llm_rnn.generate
+- [Ops-Deployment](Ops-Deployment.md) — Considérations de déploiement
+- [Troubleshooting](Troubleshooting.md) — Problèmes courants et correctifs