living-documentation 8.11.0 → 8.13.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.fr.md +104 -100
- package/README.md +105 -101
- package/dist/src/frontend/admin.html +1 -1
- package/dist/src/frontend/context.html +1 -1
- package/dist/src/frontend/diagram.html +1 -1
- package/dist/src/frontend/export.js +1 -1
- package/dist/src/frontend/index.html +6 -3
- package/dist/src/frontend/shape-editor.html +1 -1
- package/images/living_documentation.jpg +0 -0
- package/images/readme-intelligent-search-demo.jpg +0 -0
- package/package.json +1 -1
- package/dist/src/frontend/vendor/font-awesome/css/all.min.css +0 -9
- package/dist/src/frontend/vendor/font-awesome/webfonts/fa-brands-400.ttf +0 -0
- package/dist/src/frontend/vendor/font-awesome/webfonts/fa-brands-400.woff2 +0 -0
- package/dist/src/frontend/vendor/font-awesome/webfonts/fa-regular-400.ttf +0 -0
- package/dist/src/frontend/vendor/font-awesome/webfonts/fa-regular-400.woff2 +0 -0
- package/dist/src/frontend/vendor/font-awesome/webfonts/fa-solid-900.ttf +0 -0
- package/dist/src/frontend/vendor/font-awesome/webfonts/fa-solid-900.woff2 +0 -0
- package/dist/src/frontend/vendor/font-awesome/webfonts/fa-v4compatibility.ttf +0 -0
- package/dist/src/frontend/vendor/font-awesome/webfonts/fa-v4compatibility.woff2 +0 -0
- package/dist/src/frontend/vendor/tailwindcss-typography.js +0 -94
- package/dist/src/frontend/vendor/tailwindcss.js +0 -91
- package/images/living_documentation.png +0 -0
- package/images/readme-code-blocks.png +0 -0
- package/images/readme-intelligent-search-demo.png +0 -0
package/README.fr.md
CHANGED
|
@@ -13,7 +13,7 @@ npx living-documentation # assistant interactif (EN/FR)
|
|
|
13
13
|
npx living-documentation ./docs # servir un dossier existant
|
|
14
14
|
```
|
|
15
15
|
|
|
16
|
-
|
|
17
17
|
|
|
18
18
|
---
|
|
19
19
|
|
|
@@ -23,15 +23,15 @@ npx living-documentation ./docs # servir un dossier existant
|
|
|
23
23
|
|
|
24
24
|
Living Documentation embarque un **serveur MCP** sur `POST /mcp`. N'importe quel agent compatible MCP peut lire, créer et auditer la documentation projet de façon autonome.
|
|
25
25
|
|
|
26
|
-
| Ce que vous dites…
|
|
27
|
-
|
|
|
28
|
-
|
|
|
29
|
-
|
|
|
30
|
-
|
|
|
31
|
-
|
|
|
32
|
-
|
|
|
26
|
+
| Ce que vous dites… | Ce que l'agent déclenche… | Ce qui se passe |
|
|
27
|
+
| ------------------------------------------------------------ | ----------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------- |
|
|
28
|
+
| _« feature terminée »_ / _"feature done"_ | `create-adr` | Cherche les ADR existants, supplante l'ADR obsolète s'il y en a, écrit un nouvel ADR en `To be validated`, relie les fichiers source via les métadonnées. |
|
|
29
|
+
| _« audite les ADR »_ / _"audit the ADRs"_ | `audit-adrs-drift` | Liste chaque ADR sous 80 % de fiabilité et remet chacun en cohérence — soit re-baseliner les hashes, soit supplanter après confirmation. |
|
|
30
|
+
| _« vérifie la pertinence de cet ADR »_ / _"review this ADR"_ | `review-adr-relevance` | Revue d'un ADR précis contre les fichiers source liés ; rafraîchit les hashes ou propose la supersession. |
|
|
31
|
+
| _« retrodocumente depuis git »_ / _"backfill ADRs from git"_ | `retrodocument-adrs-from-git` | Parcourt l'historique git du plus ancien au plus récent et crée des ADR pour les décisions durables jamais documentées. |
|
|
32
|
+
| _« donne-moi la big picture »_ | `generate-context-diagram` | Crée un diagramme C4 de contexte **dérivé des documents**, jamais inventé. |
|
|
33
33
|
|
|
34
|
-
**Tous les nouveaux ADR atterrissent en `To be validated`.**
|
|
34
|
+
**Tous les nouveaux ADR atterrissent en `To be validated`.** _Vous_ les promouvez. L'agent ne promeut jamais à votre place.
|
|
35
35
|
|
|
36
36
|
### 2. Sans IA, en solo
|
|
37
37
|
|
|
@@ -80,7 +80,10 @@ Ou manuellement dans `.claude/settings.json` :
|
|
|
80
80
|
```json
|
|
81
81
|
{
|
|
82
82
|
"mcpServers": {
|
|
83
|
-
"living-documentation": {
|
|
83
|
+
"living-documentation": {
|
|
84
|
+
"type": "http",
|
|
85
|
+
"url": "http://localhost:4321/mcp"
|
|
86
|
+
}
|
|
84
87
|
}
|
|
85
88
|
}
|
|
86
89
|
```
|
|
@@ -92,7 +95,10 @@ Dans `~/Library/Application Support/Claude/claude_desktop_config.json` (macOS),
|
|
|
92
95
|
```json
|
|
93
96
|
{
|
|
94
97
|
"mcpServers": {
|
|
95
|
-
"living-documentation": {
|
|
98
|
+
"living-documentation": {
|
|
99
|
+
"type": "http",
|
|
100
|
+
"url": "http://localhost:4321/mcp"
|
|
101
|
+
}
|
|
96
102
|
}
|
|
97
103
|
}
|
|
98
104
|
```
|
|
@@ -121,42 +127,42 @@ Même endpoint HTTP : `http://localhost:4321/mcp` (transport Streamable HTTP, sa
|
|
|
121
127
|
|
|
122
128
|
### Tools (19)
|
|
123
129
|
|
|
124
|
-
| Groupe
|
|
125
|
-
|
|
|
126
|
-
| Onboarding
|
|
127
|
-
| Documents
|
|
128
|
-
|
|
|
129
|
-
|
|
|
130
|
-
|
|
|
131
|
-
| Diagrammes
|
|
132
|
-
|
|
|
133
|
-
|
|
|
134
|
-
| Code source (fallback) | `list_source_files`
|
|
135
|
-
|
|
|
136
|
-
|
|
|
137
|
-
| Métadonnées
|
|
138
|
-
|
|
|
139
|
-
|
|
|
140
|
-
|
|
|
141
|
-
|
|
|
142
|
-
| Audit ADR
|
|
143
|
-
|
|
|
144
|
-
| Rétrodocumentation
|
|
130
|
+
| Groupe | Tool | Description |
|
|
131
|
+
| ---------------------- | ----------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------- |
|
|
132
|
+
| Onboarding | `get_server_guide` | Retourne le guide du serveur : workflow, conventions, règles des diagrammes. |
|
|
133
|
+
| Documents | `list_documents` | Inventaire : `id`, `title`, `category`, `folder`, `linkHref`. |
|
|
134
|
+
| | `read_document` | Contenu Markdown brut d'un document. |
|
|
135
|
+
| | `create_document` | Crée un nouveau `.md` (nom de fichier dérivé du pattern, paramètre `date` optionnel pour la rétro-doc). |
|
|
136
|
+
| | `update_document` | Écrase un document existant (correction de dérive, supersession). |
|
|
137
|
+
| Diagrammes | `list_diagrams` | Liste les diagrammes sauvegardés. |
|
|
138
|
+
| | `read_diagram` | Lit les nœuds + arêtes d'un diagramme. |
|
|
139
|
+
| | `create_diagram` | Crée / écrase un diagramme (garde-fous serveur : progression C4 et labels d'arêtes). |
|
|
140
|
+
| Code source (fallback) | `list_source_files` | Liste les fichiers sous `sourceRoot` (ignore : `node_modules`, `dist`, `.git`…). |
|
|
141
|
+
| | `read_source_file` | Lit un fichier sous `sourceRoot`. |
|
|
142
|
+
| | `search_source` | Recherche grep-like sous `sourceRoot`. |
|
|
143
|
+
| Métadonnées | `list_metadata` | Fichiers source liés à un document. |
|
|
144
|
+
| | `get_accuracy` | Statut par entrée (`unchanged` / `modified` / `missing`) + accuracy pondérée ∈ [0, 1]. |
|
|
145
|
+
| | `add_metadata` | Attache un fichier source (chemin sous `sourceRoot`), enregistre SHA-256. **Saute les god files.** |
|
|
146
|
+
| | `remove_metadata` | Détache un lien (idempotent — pour renames/deletes). |
|
|
147
|
+
| | `refresh_metadata` | Re-hashe chaque lien (re-baseline après une mise à jour). |
|
|
148
|
+
| Audit ADR | `list_adrs_below_accuracy` | Jusqu'à 10 ADR dont l'accuracy < 80 %, triés du plus dégradé. Exclut `SuperSeeded` et non-ADR. |
|
|
149
|
+
| | `review_adr_relevance` | Rapport factuel sur un ADR + fichiers en dérive à relire. Retourne un `state` pour piloter le LLM. |
|
|
150
|
+
| Rétrodocumentation | `retrodocument_adrs_from_git` | Jusqu'à 200 commits git (du plus ancien), classés `candidate` / `trivial` / `merge`, avec flags god-files. Pour backfiller les ADR manquants. |
|
|
145
151
|
|
|
146
152
|
### Prompts (10)
|
|
147
153
|
|
|
148
|
-
| Groupe
|
|
149
|
-
|
|
|
154
|
+
| Groupe | Prompt | Quand l'invoquer |
|
|
155
|
+
| ---------------- | ----------------------------- | ----------------------------------------------------------------------------------------------------------------- |
|
|
150
156
|
| Cycle de vie ADR | `create-adr` | Une feature vient d'être implémentée ou modifiée. Enregistre la décision, supersede l'ADR antérieur si pertinent. |
|
|
151
|
-
|
|
|
152
|
-
|
|
|
153
|
-
|
|
|
154
|
-
| Diagrammes
|
|
155
|
-
|
|
|
156
|
-
|
|
|
157
|
-
|
|
|
158
|
-
|
|
|
159
|
-
|
|
|
157
|
+
| | `audit-adrs-drift` | Audit batch : ramener chaque ADR en dérive à un état clair (re-baseline ou supersession confirmée). |
|
|
158
|
+
| | `review-adr-relevance` | Revue d'un ADR précis contre ses fichiers source liés. |
|
|
159
|
+
| | `retrodocument-adrs-from-git` | Backfill d'ADR depuis l'historique git quand le projet en manque. |
|
|
160
|
+
| Diagrammes | `generate-context-diagram` | DÉFAUT. Diagramme C4 de contexte, gardé serveur. |
|
|
161
|
+
| | `generate-container-diagram` | Sur demande explicite. Diagramme C4 conteneur d'un système. |
|
|
162
|
+
| | `generate-uml-diagram` | Sur demande explicite. UML classe/séquence/état/activité/cas d'usage. |
|
|
163
|
+
| | `generate-screen-guide` | Sur demande explicite. Capture annotée avec post-it callouts. |
|
|
164
|
+
| | `update-diagram-from-docs` | Relit les documents source pour mettre à jour les diagrammes existants. |
|
|
165
|
+
| | `flow`, `erd` | Diagrammes flow linéaires / entité-relation. |
|
|
160
166
|
|
|
161
167
|
Un `GET http://localhost:4321/mcp` retourne les schémas live des tools et prompts pour inspection.
|
|
162
168
|
|
|
@@ -176,7 +182,7 @@ Un `GET http://localhost:4321/mcp` retourne les schémas live des tools et promp
|
|
|
176
182
|
|
|
177
183
|
|
|
178
184
|
|
|
179
|
-
|
|
180
186
|
|
|
181
187
|
---
|
|
182
188
|
|
|
@@ -230,12 +236,12 @@ Créé automatiquement dans votre dossier de doc au premier lancement. Modifiabl
|
|
|
230
236
|
}
|
|
231
237
|
```
|
|
232
238
|
|
|
233
|
-
| Champ
|
|
234
|
-
|
|
|
235
|
-
| `filenamePattern`
|
|
236
|
-
| `extraFiles`
|
|
237
|
-
| `sourceRoot`
|
|
238
|
-
| `blockedFileExtensions` | Liste de sécurité des extensions de pièces jointes, éditable en Admin.
|
|
239
|
+
| Champ | Rôle |
|
|
240
|
+
| ----------------------- | ----------------------------------------------------------------------------------------------------------------------------------------- |
|
|
241
|
+
| `filenamePattern` | Convention de nom de fichier utilisée pour extraire date / catégorie / titre. Le token `[Category]` est obligatoire, exactement une fois. |
|
|
242
|
+
| `extraFiles` | Fichiers Markdown ordonnés **hors** du dossier docs (ex. `README.md`, `CLAUDE.md`). Affichés en premier dans General. |
|
|
243
|
+
| `sourceRoot` | Où vit votre code (relatif au dossier docs). Défaut : `..`. Utilisé par les tools MCP source + métadonnées. |
|
|
244
|
+
| `blockedFileExtensions` | Liste de sécurité des extensions de pièces jointes, éditable en Admin. |
|
|
239
245
|
|
|
240
246
|
**Tous les chemins sont relatifs POSIX** pour que `.living-doc.json` reste portable. Les chemins absolus legacy sont migrés silencieusement à la première lecture.
|
|
241
247
|
|
|
@@ -245,26 +251,24 @@ Créé automatiquement dans votre dossier de doc au premier lancement. Modifiabl
|
|
|
245
251
|
|
|
246
252
|
## Export
|
|
247
253
|
|
|
248
|
-
| Format
|
|
249
|
-
|
|
|
250
|
-
| PDF (par doc)
|
|
251
|
-
| HTML — mode Notion
|
|
252
|
-
| HTML — mode Confluence
|
|
253
|
-
| Bundle Markdown
|
|
254
|
+
| Format | Endpoint | Notes |
|
|
255
|
+
| ---------------------- | --------------------------- | ------------------------------------------------------------------ |
|
|
256
|
+
| PDF (par doc) | `POST /api/export/html` | Boîte de dialogue d'impression du navigateur depuis le HTML rendu. |
|
|
257
|
+
| HTML — mode Notion | `POST /api/export/html` | Bundle HTML unique adapté à l'import Notion. |
|
|
258
|
+
| HTML — mode Confluence | `POST /api/export/html` | Bundle HTML zippé adapté à l'import Confluence. |
|
|
259
|
+
| Bundle Markdown | `POST /api/export/markdown` | Zip de tous les documents avec liens normalisés. |
|
|
254
260
|
|
|
255
261
|
---
|
|
256
262
|
|
|
257
263
|
## Surfaces UI
|
|
258
264
|
|
|
259
|
-
| URL
|
|
260
|
-
|
|
|
261
|
-
| `/`
|
|
262
|
-
| `/admin`
|
|
263
|
-
| `/diagram?id=`
|
|
264
|
-
| `/shape-editor`
|
|
265
|
-
| `/context`
|
|
266
|
-
|
|
267
|
-
|
|
265
|
+
| URL | Page |
|
|
266
|
+
| --------------- | ---------------------------------------------------------------------------------------------------- |
|
|
267
|
+
| `/` | Viewer — sidebar, rendu document, édition inline, snippets, recherche, pièces jointes. |
|
|
268
|
+
| `/admin` | Config — titre, thème, pattern de filename, extra files, source root, liste de sécurité fichiers. |
|
|
269
|
+
| `/diagram?id=` | Éditeur de diagrammes (vis-network) avec conventions C4, ports, guides d'alignement, undo/redo. |
|
|
270
|
+
| `/shape-editor` | Éditeur de bibliothèques de formes personnalisées — icônes SVG, couleurs par défaut, ports. |
|
|
271
|
+
| `/context` | Page de contexte IA — instructions, règles, mémoire, **explorateur MCP** (tester les tools en live). |
|
|
268
272
|
|
|
269
273
|
---
|
|
270
274
|
|
|
@@ -273,42 +277,42 @@ Créé automatiquement dans votre dossier de doc au premier lancement. Modifiabl
|
|
|
273
277
|
<details>
|
|
274
278
|
<summary>API HTTP complète (cliquer pour déplier)</summary>
|
|
275
279
|
|
|
276
|
-
| Méthode | Endpoint | Description
|
|
277
|
-
| -------- | ------------------------------ |
|
|
278
|
-
| `GET` | `/api/documents` | Liste les documents avec métadonnées (inclut extra files).
|
|
279
|
-
| `GET` | `/api/documents/:id` | Contenu du document + HTML rendu.
|
|
280
|
-
| `POST` | `/api/documents` | Crée depuis `{ title, category, folder?, content?, date? }`.
|
|
281
|
-
| `PUT` | `/api/documents/:id` | Sauvegarde du contenu sur disque.
|
|
282
|
-
| `DELETE` | `/api/documents/:id` | Supprime un document.
|
|
283
|
-
| `GET` | `/api/documents/search?q=` | Recherche plein-texte.
|
|
284
|
-
| `GET` | `/api/config` | Lit la config.
|
|
280
|
+
| Méthode | Endpoint | Description |
|
|
281
|
+
| -------- | ------------------------------ | ------------------------------------------------------------------------------------------------------------------- |
|
|
282
|
+
| `GET` | `/api/documents` | Liste les documents avec métadonnées (inclut extra files). |
|
|
283
|
+
| `GET` | `/api/documents/:id` | Contenu du document + HTML rendu. |
|
|
284
|
+
| `POST` | `/api/documents` | Crée depuis `{ title, category, folder?, content?, date? }`. |
|
|
285
|
+
| `PUT` | `/api/documents/:id` | Sauvegarde du contenu sur disque. |
|
|
286
|
+
| `DELETE` | `/api/documents/:id` | Supprime un document. |
|
|
287
|
+
| `GET` | `/api/documents/search?q=` | Recherche plein-texte. |
|
|
288
|
+
| `GET` | `/api/config` | Lit la config. |
|
|
285
289
|
| `PUT` | `/api/config` | Met à jour la config (`title`, `theme`, `filenamePattern`, `extraFiles`, `sourceRoot`, `blockedFileExtensions`, …). |
|
|
286
|
-
| `GET` | `/api/browse?path=` | Liste les dossiers et `.md` à un chemin.
|
|
287
|
-
| `POST` | `/api/browse/mkdir` | Crée un dossier sous la racine docs.
|
|
288
|
-
| `POST` | `/api/images/upload` | Upload d'image base64 → `<docs>/images/`.
|
|
289
|
-
| `POST` | `/api/files/upload` | Upload de pièce jointe base64 → `<docs>/files/`.
|
|
290
|
-
| `GET` | `/api/files` | Liste toutes les pièces jointes (chronologique).
|
|
291
|
-
| `PUT` | `/api/files/:filename` | Remplace une pièce jointe.
|
|
292
|
-
| `DELETE` | `/api/files/:filename` | Supprime une pièce jointe.
|
|
293
|
-
| `GET` | `/api/metadata/:docId` | Rapport de fiabilité d'un doc.
|
|
294
|
-
| `POST` | `/api/metadata/:docId` | Ajoute ou remplace un lien.
|
|
295
|
-
| `DELETE` | `/api/metadata/:docId` | Retire un lien.
|
|
296
|
-
| `POST` | `/api/metadata/:docId/refresh` | Re-baseline les hashes.
|
|
297
|
-
| `GET` | `/api/browse-source?path=` | Navigue l'arbre source ancré sur `sourceRoot`.
|
|
298
|
-
| `GET` | `/api/diagrams` | Liste les diagrammes sauvegardés.
|
|
299
|
-
| `GET` | `/api/diagrams/:id` | Lit un diagramme (nœuds + arêtes).
|
|
300
|
-
| `PUT` | `/api/diagrams/:id` | Crée ou met à jour un diagramme.
|
|
301
|
-
| `DELETE` | `/api/diagrams/:id` | Supprime un diagramme.
|
|
302
|
-
| `GET` | `/api/shape-libraries` | Liste les bibliothèques de formes personnalisées.
|
|
303
|
-
| `PUT` | `/api/shape-libraries/:id` | Sauvegarde une bibliothèque de formes.
|
|
304
|
-
| `GET` | `/api/annotations[/:docId]` | Liste les annotations (tous docs / un doc).
|
|
305
|
-
| `POST` | `/api/annotations/:docId` | Ajoute une annotation.
|
|
306
|
-
| `DELETE` | `/api/annotations/:docId/:id` | Supprime une annotation.
|
|
307
|
-
| `POST` | `/api/export/html` | Export HTML — modes Notion / Confluence.
|
|
308
|
-
| `POST` | `/api/export/markdown` | Export bundle Markdown.
|
|
309
|
-
| `GET` | `/api/wordcloud?path=&ext=` | Concatène récursivement les fichiers source filtrés en texte brut.
|
|
310
|
-
| `POST` | `/mcp` | Endpoint Model Context Protocol (Streamable HTTP).
|
|
311
|
-
| `GET` | `/mcp` | Résumé live des schémas tools + prompts.
|
|
290
|
+
| `GET` | `/api/browse?path=` | Liste les dossiers et `.md` à un chemin. |
|
|
291
|
+
| `POST` | `/api/browse/mkdir` | Crée un dossier sous la racine docs. |
|
|
292
|
+
| `POST` | `/api/images/upload` | Upload d'image base64 → `<docs>/images/`. |
|
|
293
|
+
| `POST` | `/api/files/upload` | Upload de pièce jointe base64 → `<docs>/files/`. |
|
|
294
|
+
| `GET` | `/api/files` | Liste toutes les pièces jointes (chronologique). |
|
|
295
|
+
| `PUT` | `/api/files/:filename` | Remplace une pièce jointe. |
|
|
296
|
+
| `DELETE` | `/api/files/:filename` | Supprime une pièce jointe. |
|
|
297
|
+
| `GET` | `/api/metadata/:docId` | Rapport de fiabilité d'un doc. |
|
|
298
|
+
| `POST` | `/api/metadata/:docId` | Ajoute ou remplace un lien. |
|
|
299
|
+
| `DELETE` | `/api/metadata/:docId` | Retire un lien. |
|
|
300
|
+
| `POST` | `/api/metadata/:docId/refresh` | Re-baseline les hashes. |
|
|
301
|
+
| `GET` | `/api/browse-source?path=` | Navigue l'arbre source ancré sur `sourceRoot`. |
|
|
302
|
+
| `GET` | `/api/diagrams` | Liste les diagrammes sauvegardés. |
|
|
303
|
+
| `GET` | `/api/diagrams/:id` | Lit un diagramme (nœuds + arêtes). |
|
|
304
|
+
| `PUT` | `/api/diagrams/:id` | Crée ou met à jour un diagramme. |
|
|
305
|
+
| `DELETE` | `/api/diagrams/:id` | Supprime un diagramme. |
|
|
306
|
+
| `GET` | `/api/shape-libraries` | Liste les bibliothèques de formes personnalisées. |
|
|
307
|
+
| `PUT` | `/api/shape-libraries/:id` | Sauvegarde une bibliothèque de formes. |
|
|
308
|
+
| `GET` | `/api/annotations[/:docId]` | Liste les annotations (tous docs / un doc). |
|
|
309
|
+
| `POST` | `/api/annotations/:docId` | Ajoute une annotation. |
|
|
310
|
+
| `DELETE` | `/api/annotations/:docId/:id` | Supprime une annotation. |
|
|
311
|
+
| `POST` | `/api/export/html` | Export HTML — modes Notion / Confluence. |
|
|
312
|
+
| `POST` | `/api/export/markdown` | Export bundle Markdown. |
|
|
313
|
+
| `GET` | `/api/wordcloud?path=&ext=` | Concatène récursivement les fichiers source filtrés en texte brut. |
|
|
314
|
+
| `POST` | `/mcp` | Endpoint Model Context Protocol (Streamable HTTP). |
|
|
315
|
+
| `GET` | `/mcp` | Résumé live des schémas tools + prompts. |
|
|
312
316
|
|
|
313
317
|
</details>
|
|
314
318
|
|