diff --git a/docs/TOPO_LOGIQUE_METIER.md b/docs/TOPO_LOGIQUE_METIER.md new file mode 100644 index 0000000..2318bf6 --- /dev/null +++ b/docs/TOPO_LOGIQUE_METIER.md @@ -0,0 +1,250 @@ +# Topo – Logique métier de l’outil éditorial (Web Edition ↔ Gitea ↔ apply-ticket ↔ CI) + +Ce document explique **ce que fait réellement l’outil**, pourquoi il existe, et comment le maintenir **sans casser** la promesse centrale : **citabilité durable + édition traçable + intégration sûre**. + +> Public visé : “commun des mortels” (nouveau contributeur, mainteneur occasionnel, moi dans 6 mois). + +--- + +## 0) La promesse (le “pourquoi”) + +On veut un site (Astro) où chaque paragraphe est : +- **citable** (URL + ancre stable), +- **corrigeable** (ouvrir un ticket pré-rempli depuis le paragraphe), +- **réparable de manière sûre** (appliquer la proposition dans les sources sans magie), +- **vérifié automatiquement** (tests + build + garde-fous en CI). + +En bref : +**Lecture → proposition → ticket → application → tests → build → publication** +…sans perdre la traçabilité, ni casser les citations historiques. + +--- + +## 1) Glossaire (pas de jargon sans définition) + +- **Ancre** : partie `#...` d’une URL (ex : `#p-8-0e65838d`). Le navigateur saute à l’élément HTML portant cet `id`. +- **Paragraphe citable** : un `
...
` dans l’article. +- **Ticket / Issue** : demande de correction sur Gitea (ex : #14). +- **PR (Pull Request)** : “demande d’ajout / fusion” : une proposition de merge d’une branche vers `master`. +- **CI** : tests automatiques exécutés sur le serveur à chaque push/PR. +- **Runner** : machine/conteneur qui exécute la CI (chez nous : DS220+ / ds220-runner). +- **DEV** : `npm run dev` (serveur Astro à la volée, pas de `dist/`). +- **BUILD / PROD-like** : `npm run build` puis servir `dist/` (ce qui ressemble à la prod). + +--- + +## 2) Vue d’ensemble : le pipeline (la “machine éditoriale”) + +### 2.1 Le flux humain (ce que fait l’éditeur) +1) Lire une page sur “Archicratie – Web Edition”. +2) Sur un paragraphe : cliquer **Proposer**. +3) Choisir **Type** (Correction / Fact-check) + **Category** (lexique, style, etc.). +4) Gitea s’ouvre en **nouvel onglet** avec un ticket pré-rempli. +5) L’éditeur écrit la proposition, justifie, et valide le ticket. + +### 2.2 Le flux technique (ce que fait la machine) +6) `apply-ticket` récupère le ticket via l’API Gitea. +7) Il retrouve le bon fichier source (MDX) + le bon paragraphe (matching sûr). +8) Il applique la modification (ou refuse si trop incertain). +9) On lance `npm test` → build + test ancres + check JS inline. +10) On commit / push. +11) La CI revalide automatiquement sur le serveur. + +--- + +## 3) Composant A — Le site (Astro) et les outils de paragraphe + +Dans le rendu final, chaque paragraphe important reçoit un `id` de forme : + +- `p-...
+ +Résultat : + +le navigateur résout #p-8-e7075fe3 sans JS. + +### 6.3 Pourquoi un fallback JS existe encore ? + +En mode npm run dev, on ne passe pas par dist/, donc pas d’injection build-time. +Le fallback JS est un filet : + +utile en DEV, + +utile si un alias manque, + +mais pas la solution principale. + +## 7) Tests & garde-fous (qualité automatique) +### 7.1 npm test doit rester “simple et vrai” + +Il exécute : + +npm run build (génère dist) + +npm run test:anchors (stabilité des ancres) + +node scripts/check-inline-js.mjs (évite les scripts inline invalides) + +### 7.2 test:anchors (baseline + churn) + +tests/anchors-baseline.json = snapshot de référence. + +check-anchors compare dist à la baseline. + +Si trop de churn → échec (donc on voit la casse). + +On met à jour la baseline uniquement quand on accepte consciemment la nouvelle réalité : +npm run test:anchors:update + +## 8) DEV vs BUILD : comprendre sans se tromper + +npm run dev → serveur Astro “live”, pas de dist/ +⇒ les alias build-time n’existent pas ⇒ fallback JS peut s’activer. + +npm run build && npx serve dist → rendu final “prod-like” +⇒ alias injectés ⇒ citations historiques fonctionnent sans JS. + +Repère immédiat : + +port 4321 = DEV + +port 3000 (serve dist) = PROD-like + +## 9) Rituels opérationnels (les 3 recettes) +### Recette 1 — Créer un ticket propre + +Cliquer “Proposer” + +Choisir Type + Category + +Dans Gitea : compléter “Proposition (remplacer par)” + “Justification” + +Ne pas détruire les lignes Chemin / Ancre / Type / State / Category + +### Recette 2 — Appliquer un ticket +en bash : +node scripts/apply-ticket.mjs