living-documentation 7.58.0 → 7.59.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.
@@ -29,6 +29,7 @@ Be specific enough that another developer or AI assistant can apply the same rul
29
29
  Example:
30
30
 
31
31
  - store project-level AI instructions in `AI/PROJECT-INSTRUCTIONS.md`;
32
+ - document the stack and commands in `AI/PROJECT-STACK.md` and `AI/PROJECT-USEFUL-COMMANDS.md`;
32
33
  - expose tool-specific entry points through `AGENTS.md` and `CLAUDE.md`;
33
34
  - keep reusable AI rules in `AI/rules/*.md`;
34
35
  - use symbolic links when a document must appear in Living Documentation without duplicating the source of truth.
@@ -36,6 +36,10 @@ The internal `AI/default/` template folder is removed from the initialized docum
36
36
 
37
37
  `AI/PROJECT-INSTRUCTIONS.md` is the shared operating guide for every AI assistant working on the project.
38
38
 
39
+ `AI/PROJECT-STACK.md` describes the stack, useful source tree, core concepts, and structural conventions of the project.
40
+
41
+ `AI/PROJECT-USEFUL-COMMANDS.md` lists the commands that are actually useful to install, run, test, verify, and maintain the project.
42
+
39
43
  `AI/rules/*.md` contains reusable rules that AI assistants must apply when they touch matching files.
40
44
 
41
45
  `ADRS/*.md` contains durable decisions. ADRs explain why the project works a certain way.
@@ -47,6 +51,7 @@ Open the **AI Context** page from the main navigation.
47
51
  This page should let you verify:
48
52
 
49
53
  - that `AGENTS.md`, `CLAUDE.md`, and `memory/MEMORY.md` appear as documents under `AI/`;
54
+ - that `PROJECT-INSTRUCTIONS.md`, `PROJECT-STACK.md`, and `PROJECT-USEFUL-COMMANDS.md` are visible and adapted to your project;
50
55
  - that AI rules are visible under `AI/rules/`;
51
56
  - that the MCP explorer shows the `living-documentation` server, the `/mcp` endpoint, the available tools, and the prompts.
52
57
 
@@ -58,12 +63,15 @@ An AI assistant should:
58
63
 
59
64
  1. Read its entry point: `AGENTS.md` or `CLAUDE.md`.
60
65
  2. Follow the link to `AI/PROJECT-INSTRUCTIONS.md`.
61
- 3. Read `memory/MEMORY.md` and load only relevant memory files.
62
- 4. Read the matching rules in `AI/rules/*.md`.
63
- 5. Inspect ADR frontmatter when a task may touch an existing decision.
64
- 6. Make the requested change.
65
- 7. At the end of a coherent feature, update durable documentation when needed.
66
- 8. Attach Living Documentation metadata to created or updated documents when source files prove their content.
66
+ 3. Read `AI/PROJECT-STACK.md` to understand the technical choices, useful source tree, and project concepts.
67
+ 4. Read `AI/PROJECT-USEFUL-COMMANDS.md` to use the right commands instead of guessing them.
68
+ 5. Read `memory/MEMORY.md` and load only relevant memory files.
69
+ 6. Read the matching rules in `AI/rules/*.md`.
70
+ 7. Inspect ADR frontmatter when a task may touch an existing decision.
71
+ 8. Make the requested change.
72
+ 9. At the end of a coherent feature, update durable documentation when needed.
73
+ 10. Update `PROJECT-STACK.md` or `PROJECT-USEFUL-COMMANDS.md` if the task makes their content wrong, incomplete, or obsolete.
74
+ 11. Attach Living Documentation metadata to created or updated documents when source files prove their content.
67
75
 
68
76
  ## Project Instructions
69
77
 
@@ -100,4 +108,5 @@ After setup, remove only what is not useful for your project.
100
108
  Common cleanup:
101
109
 
102
110
  - keep this document if future contributors should understand the initialized structure;
111
+ - adapt `PROJECT-STACK.md` and `PROJECT-USEFUL-COMMANDS.md` as soon as the first real project commands and conventions are known;
103
112
  - keep the ADR example only if you want an in-project template.
@@ -10,10 +10,12 @@ Before changing the project:
10
10
 
11
11
  1. Read `AGENTS.md` or `CLAUDE.md`, depending on the tool.
12
12
  2. Read this file: `DOCS_FOLDER/AI/PROJECT-INSTRUCTIONS.md`.
13
- 3. Read `memory/MEMORY.md` and load only the memory files relevant to the task.
14
- 4. Read every rule in `DOCS_FOLDER/AI/rules/*.md`.
15
- 5. Inspect existing ADRs: list `DOCS_FOLDER/ADRS/`, read only `description` and `tags` first, then open the full ADR only when relevant.
16
- 6. Check whether the Living Documentation MCP server is available before creating or modifying documentation.
13
+ 3. Read `DOCS_FOLDER/AI/PROJECT-STACK.md` to understand the stack, useful source tree, core concepts, and structural conventions.
14
+ 4. Read `DOCS_FOLDER/AI/PROJECT-USEFUL-COMMANDS.md` to know the development, build, test, lint, and setup commands.
15
+ 5. Read `memory/MEMORY.md` and load only the memory files relevant to the task.
16
+ 6. Read every rule in `DOCS_FOLDER/AI/rules/*.md`.
17
+ 7. Inspect existing ADRs: list `DOCS_FOLDER/ADRS/`, read only `description` and `tags` first, then open the full ADR only when relevant.
18
+ 8. Check whether the Living Documentation MCP server is available before creating or modifying documentation.
17
19
 
18
20
  Replace `DOCS_FOLDER` with the real documentation folder used by this project, for example `documentation`, `docs`, or `doc`.
19
21
 
@@ -89,6 +91,22 @@ When the AI creates or updates an ADR or technical document:
89
91
 
90
92
  Metadata is not optional for documents that describe code. If metadata cannot be updated, the AI must say so in its final response and list the files that should be attached.
91
93
 
94
+ ## Project Stack And Commands
95
+
96
+ `DOCS_FOLDER/AI/PROJECT-STACK.md` contains the operational project summary: technical stack, important source areas, core concepts, and structural conventions.
97
+
98
+ `DOCS_FOLDER/AI/PROJECT-USEFUL-COMMANDS.md` contains commands that are actually useful: installation, local development, build, tests, lint, formatting, setup, and dangerous commands.
99
+
100
+ These two files are living documentation. The AI must propose updates when a task makes their content false, incomplete, or insufficiently precise.
101
+
102
+ Rules:
103
+
104
+ - keep these files short, concrete, and action-oriented;
105
+ - do not duplicate ADRs in them;
106
+ - point to ADRs when a durable explanation exists;
107
+ - verify that a command exists before documenting it;
108
+ - do not silently change a structural convention or dangerous command: explain the change and wait for validation when the risk is significant.
109
+
92
110
  ## AI Rules
93
111
 
94
112
  Rules live in `DOCS_FOLDER/AI/rules/*.md`.
@@ -114,7 +132,7 @@ Memory is for stable, frequently reused context. Durable decisions should instea
114
132
 
115
133
  ## Changing AI Instruction Files
116
134
 
117
- The AI may propose changes to `AGENTS.md`, `CLAUDE.md`, `PROJECT-INSTRUCTIONS.md`, `memory/MEMORY.md`, or rules in `AI/rules/`.
135
+ The AI may propose changes to `AGENTS.md`, `CLAUDE.md`, `PROJECT-INSTRUCTIONS.md`, `PROJECT-STACK.md`, `PROJECT-USEFUL-COMMANDS.md`, `memory/MEMORY.md`, or rules in `AI/rules/`.
118
136
 
119
137
  But these files directly steer AI assistant behavior. Before changing them, the AI must:
120
138
 
@@ -0,0 +1,77 @@
1
+ # PROJECT-STACK - Template
2
+
3
+ This file gives the AI assistant a short, factual overview of the project. It must stay concise, concrete, and continuously maintained.
4
+
5
+ It does not replace ADRs: it helps the assistant quickly know where to look, which technologies are involved, and which concepts structure the code. For the detailed reason behind a decision, read the relevant ADRs.
6
+
7
+ ## Maintenance Rule
8
+
9
+ The AI must propose an update to this file when a task:
10
+
11
+ - introduces, removes, or replaces an important technology;
12
+ - changes a structural convention;
13
+ - adds or moves an important source area;
14
+ - changes a central business or technical concept;
15
+ - makes any information below false or incomplete.
16
+
17
+ Do not document volatile details, temporary TODOs, or information that clearly belongs in an ADR.
18
+
19
+ ## Overview
20
+
21
+ Replace this paragraph with a short project description:
22
+
23
+ - what the project does;
24
+ - who it is for;
25
+ - where the application code, documentation, and main entry points live.
26
+
27
+ ## Technical Stack
28
+
29
+ Fill only the lines that actually exist in the project. Remove irrelevant categories.
30
+
31
+ - **Main language**:
32
+ - **Runtime**:
33
+ - **Frontend framework**:
34
+ - **Backend / server framework**:
35
+ - **Database / storage**:
36
+ - **External APIs / integrations**:
37
+ - **Authentication / authorization**:
38
+ - **Styles / design system**:
39
+ - **State management**:
40
+ - **Build / bundler**:
41
+ - **Package manager**:
42
+ - **Tests**:
43
+ - **Lint / formatting**:
44
+ - **Observability / logs**:
45
+ - **Deployment / hosting**:
46
+
47
+ ## Useful Source Tree
48
+
49
+ Describe the folders or files the AI must know to orient itself quickly.
50
+
51
+ ```text
52
+ src/ <- main application code
53
+ tests/ <- automated tests
54
+ documentation/ <- Living Documentation folder, if this is the project docs folder
55
+ ```
56
+
57
+ Adapt this tree to the real project. Do not list the whole repository: keep only what helps an AI find where to work.
58
+
59
+ ## Core Concepts
60
+
61
+ List concepts that often come up in tasks.
62
+
63
+ - **Concept 1**: explain in one sentence and point to the useful ADR or document.
64
+ - **Concept 2**: explain in one sentence and point to the useful ADR or document.
65
+ - **Concept 3**: explain in one sentence and point to the useful ADR or document.
66
+
67
+ ## Structural Conventions
68
+
69
+ List conventions the AI must respect before changing code.
70
+
71
+ - Naming convention:
72
+ - Module organization:
73
+ - Error handling:
74
+ - Configuration handling:
75
+ - Test strategy:
76
+
77
+ If a convention becomes durable or comes from an important trade-off, create or update an ADR instead of overloading this file.
@@ -0,0 +1,80 @@
1
+ # PROJECT-USEFUL-COMMANDS - Template
2
+
3
+ This file describes the commands that are actually useful for working on the project. It must help an AI choose the right verification without guessing.
4
+
5
+ It must stay up to date. A wrong command is more costly than a missing command.
6
+
7
+ ## Maintenance Rule
8
+
9
+ The AI must propose an update to this file when a task:
10
+
11
+ - adds, removes, or renames a development script;
12
+ - changes the package manager;
13
+ - changes the build, test, lint, or formatting command;
14
+ - introduces a required setup step;
15
+ - reveals that a documented command no longer works.
16
+
17
+ Before adding a command, verify that it really exists in `package.json`, a Makefile, a script, or the project documentation.
18
+
19
+ ## Package Manager
20
+
21
+ State the expected package manager and the related rule.
22
+
23
+ ```text
24
+ npm | pnpm | yarn | bun | other
25
+ ```
26
+
27
+ If the project mandates a package manager, create or update a rule in `AI/rules/`.
28
+
29
+ ## Installation
30
+
31
+ | Command | When to use it | Notes |
32
+ |---|---|---|
33
+ | `npm install` | After clone or dependency changes | Adapt to the real package manager. |
34
+
35
+ ## Local Development
36
+
37
+ | Command | Effect | Notes |
38
+ |---|---|---|
39
+ | `npm run dev` | Starts the local server | Specify port and prerequisites. |
40
+
41
+ ## Quality
42
+
43
+ | Command | Effect | When to run it |
44
+ |---|---|---|
45
+ | `npm run build` | Compiles or bundles the project | After typed code, build config, or copied asset changes. |
46
+ | `npm test` | Runs tests | After behavior changes. |
47
+ | `npm run lint` | Runs lint | If the project has linting. |
48
+ | `npm run format` | Formats code | If the project has formatting. |
49
+
50
+ ## Focused Tests
51
+
52
+ Document commands that verify a limited scope without running the whole suite.
53
+
54
+ | Command | Scope |
55
+ |---|---|
56
+ | `npm test -- <pattern>` | Adapt to the real runner. |
57
+
58
+ ## Initial Setup
59
+
60
+ List required steps after a clone or initialization.
61
+
62
+ ```bash
63
+ # Example to replace
64
+ cp .env.example .env
65
+ npm install
66
+ ```
67
+
68
+ ## Dangerous Or Costly Commands
69
+
70
+ List commands that change the environment, delete data, deploy, or cost money.
71
+
72
+ | Command | Risk | Rule |
73
+ |---|---|---|
74
+ | `npm run deploy` | Real deployment | Ask for explicit validation before running. |
75
+
76
+ ## Notes For AI
77
+
78
+ - Run the smallest useful verification before finishing.
79
+ - If a command fails, report the exact command, the symptom, and the most likely hypothesis.
80
+ - Do not invent scripts: if a command is missing, say so and propose adding it.
@@ -5,10 +5,12 @@ This file is the entry point for Codex and agent-style tools.
5
5
  Before making changes:
6
6
 
7
7
  1. Read `DOCS_FOLDER/AI/PROJECT-INSTRUCTIONS.md`.
8
- 2. Read `memory/MEMORY.md` and load only useful memory files.
9
- 3. Read rules in `DOCS_FOLDER/AI/rules/*.md`.
10
- 4. Inspect ADRs in `DOCS_FOLDER/ADRS/` by reading `description` and `tags` first.
11
- 5. Use the Living Documentation MCP to create, update, and keep documentation reliable when it is available.
8
+ 2. Read `DOCS_FOLDER/AI/PROJECT-STACK.md` to understand the stack, useful source areas, core concepts, and structural conventions.
9
+ 3. Read `DOCS_FOLDER/AI/PROJECT-USEFUL-COMMANDS.md` to know the development, build, test, lint, and setup commands.
10
+ 4. Read `memory/MEMORY.md` and load only useful memory files.
11
+ 5. Read rules in `DOCS_FOLDER/AI/rules/*.md`.
12
+ 6. Inspect ADRs in `DOCS_FOLDER/ADRS/` by reading `description` and `tags` first, then open the full ADR only when relevant.
13
+ 7. Check whether the `living-documentation` MCP is available and use it to create, update, and keep documentation reliable when the task touches a decision, rule, command, stack, or technical document.
12
14
 
13
15
  Replace `DOCS_FOLDER` with the real documentation folder for this project.
14
16
 
@@ -23,6 +25,8 @@ When the MCP is available:
23
25
  - attach source files with `add_metadata` after creating or updating an ADR or technical document;
24
26
  - call `refresh_metadata` once the document is aligned with the code.
25
27
 
26
- If the MCP is not available, state that explicitly in the final response.
28
+ `PROJECT-STACK.md` and `PROJECT-USEFUL-COMMANDS.md` are living documents. If the agent discovers that they are wrong, incomplete, or obsolete, it should propose or perform their update in the same task unless the user says otherwise.
29
+
30
+ If the MCP is not available, state that explicitly in the final response and do not claim that Living Documentation metadata or hashes were updated.
27
31
 
28
32
  If a rule or project instruction conflicts with the user request, state the conflict explicitly before proceeding.
@@ -5,10 +5,12 @@ This file is the entry point for Claude.
5
5
  Before making changes:
6
6
 
7
7
  1. Read `DOCS_FOLDER/AI/PROJECT-INSTRUCTIONS.md`.
8
- 2. Read `memory/MEMORY.md` and load only useful memory files.
9
- 3. Read rules in `DOCS_FOLDER/AI/rules/*.md`.
10
- 4. Inspect ADRs in `DOCS_FOLDER/ADRS/` by reading `description` and `tags` first.
11
- 5. Use the Living Documentation MCP to create, update, and keep documentation reliable when it is available.
8
+ 2. Read `DOCS_FOLDER/AI/PROJECT-STACK.md` to understand the stack, useful source areas, core concepts, and structural conventions.
9
+ 3. Read `DOCS_FOLDER/AI/PROJECT-USEFUL-COMMANDS.md` to know the development, build, test, lint, and setup commands.
10
+ 4. Read `memory/MEMORY.md` and load only useful memory files.
11
+ 5. Read rules in `DOCS_FOLDER/AI/rules/*.md`.
12
+ 6. Inspect ADRs in `DOCS_FOLDER/ADRS/` by reading `description` and `tags` first, then open the full ADR only when relevant.
13
+ 7. Check whether the `living-documentation` MCP is available and use it to create, update, and keep documentation reliable when the task touches a decision, rule, command, stack, or technical document.
12
14
 
13
15
  Replace `DOCS_FOLDER` with the real documentation folder for this project.
14
16
 
@@ -23,6 +25,8 @@ When the MCP is available:
23
25
  - attach source files with `add_metadata` after creating or updating an ADR or technical document;
24
26
  - call `refresh_metadata` once the document is aligned with the code.
25
27
 
26
- If the MCP is not available, state that explicitly in the final response.
28
+ `PROJECT-STACK.md` and `PROJECT-USEFUL-COMMANDS.md` are living documents. If the agent discovers that they are wrong, incomplete, or obsolete, it should propose or perform their update in the same task unless the user says otherwise.
29
+
30
+ If the MCP is not available, state that explicitly in the final response and do not claim that Living Documentation metadata or hashes were updated.
27
31
 
28
32
  If a rule or project instruction conflicts with the user request, state the conflict explicitly before proceeding.
@@ -29,6 +29,7 @@ Soyez assez spécifique pour qu'un autre développeur ou assistant IA puisse app
29
29
  Exemple :
30
30
 
31
31
  - stocker les instructions IA projet dans `AI/PROJECT-INSTRUCTIONS.md` ;
32
+ - documenter la stack et les commandes dans `AI/PROJECT-STACK.md` et `AI/PROJECT-USEFUL-COMMANDS.md` ;
32
33
  - exposer les points d'entrée propres aux outils via `AGENTS.md` et `CLAUDE.md` ;
33
34
  - garder les règles IA réutilisables dans `AI/rules/*.md` ;
34
35
  - utiliser des liens symboliques quand un document doit apparaître dans Living Documentation sans dupliquer la source de vérité.
@@ -32,6 +32,10 @@ Autrement dit, les liens ne pointent pas vers un autre fichier dans le dossier d
32
32
 
33
33
  `AI/PROJECT-INSTRUCTIONS.md` est le guide de travail partagé par tous les assistants IA du projet.
34
34
 
35
+ `AI/PROJECT-STACK.md` décrit la stack, l'arborescence source utile, les concepts centraux et les conventions structurantes du projet.
36
+
37
+ `AI/PROJECT-USEFUL-COMMANDS.md` liste les commandes réellement utiles pour installer, lancer, tester, vérifier et maintenir le projet.
38
+
35
39
  `AI/rules/*.md` contient les règles réutilisables que les assistants IA doivent appliquer lorsqu'ils effectuent des modifications sur le projet.
36
40
 
37
41
  `ADRS/*.md` contient les décisions durables. Les ADR (Architecture Decision Records) expliquent pourquoi le projet fonctionne d'une certaine manière, ils sont automatiquement créés par l'agent IA lorsqu'il réalise ses tâches tel que cela lui est expliqué dans les instructions projet.
@@ -43,6 +47,7 @@ Ouvrir la page **Contexte IA** depuis la barre principale.
43
47
  Cette page doit vous permettre de vérifier :
44
48
 
45
49
  - que `AGENTS.md`, `CLAUDE.md` et `memory/MEMORY.md` apparaissent comme documents dans `AI/` ;
50
+ - que `PROJECT-INSTRUCTIONS.md`, `PROJECT-STACK.md` et `PROJECT-USEFUL-COMMANDS.md` sont visibles et adaptés à votre projet ;
46
51
  - que les règles IA sont visibles dans `AI/rules/` ;
47
52
  - que l'explorateur MCP affiche le serveur `living-documentation`, l'endpoint `/mcp`, les outils disponibles et les prompts.
48
53
 
@@ -54,12 +59,15 @@ Pour information, le fonctionnement d'un assistant IA est le suivant :
54
59
 
55
60
  1. Lire son point d'entrée : `AGENTS.md` ou `CLAUDE.md`.
56
61
  2. Suivre le lien vers `AI/PROJECT-INSTRUCTIONS.md`.
57
- 3. Lire `memory/MEMORY.md` et charger seulement les fichiers mémoire pertinents.
58
- 4. Lire les règles applicables dans `AI/rules/*.md`.
59
- 5. Inspecter le frontmatter des ADR lorsqu'une tâche peut toucher une décision existante.
60
- 6. Réaliser la modification demandée.
61
- 7. À la fin d'une feature cohérente, mettre à jour la documentation durable si nécessaire en utilisant le MCP Living-Documentation intégré.
62
- 8. Attacher les métadonnées Living Documentation aux documents créés ou mis à jour lorsque des fichiers source prouvent leur contenu.
62
+ 3. Lire `AI/PROJECT-STACK.md` pour comprendre les choix techniques, l'arborescence utile et les concepts du projet.
63
+ 4. Lire `AI/PROJECT-USEFUL-COMMANDS.md` pour utiliser les bonnes commandes au lieu de les deviner.
64
+ 5. Lire `memory/MEMORY.md` et charger seulement les fichiers mémoire pertinents.
65
+ 6. Lire les règles applicables dans `AI/rules/*.md`.
66
+ 7. Inspecter le frontmatter des ADR lorsqu'une tâche peut toucher une décision existante.
67
+ 8. Réaliser la modification demandée.
68
+ 9. À la fin d'une feature cohérente, mettre à jour la documentation durable si nécessaire en utilisant le MCP Living-Documentation intégré.
69
+ 10. Mettre à jour `PROJECT-STACK.md` ou `PROJECT-USEFUL-COMMANDS.md` si la tâche rend leur contenu faux, incomplet ou obsolète.
70
+ 11. Attacher les métadonnées Living Documentation aux documents créés ou mis à jour lorsque des fichiers source prouvent leur contenu.
63
71
 
64
72
  ## ADR
65
73
 
@@ -88,4 +96,5 @@ Après initialisation, supprimez seulement ce qui n'est pas utile au projet.
88
96
  Nettoyage courant :
89
97
 
90
98
  - garder ce document si les futurs contributeurs doivent comprendre la structure initialisée ;
99
+ - adapter `PROJECT-STACK.md` et `PROJECT-USEFUL-COMMANDS.md` dès que les premières commandes et conventions réelles du projet sont connues ;
91
100
  - garder l'ADR exemple seulement si vous voulez un template dans le projet.
@@ -10,16 +10,16 @@ Avant de modifier le projet :
10
10
 
11
11
  1. Lire `AGENTS.md` ou `CLAUDE.md`, selon l'outil utilisé.
12
12
  2. Lire ce fichier : `DOCS_FOLDER/AI/PROJECT-INSTRUCTIONS.md`.
13
- 3. Lire `memory/MEMORY.md` et charger seulement les fichiers mémoire utiles à la tâche.
14
- 4. Lire toutes les règles dans `DOCS_FOLDER/AI/rules/*.md`.
15
- 5. Inspecter les ADR existants : lister `DOCS_FOLDER/ADRS/`, lire d'abord `description` et `tags`, puis ouvrir l'ADR complet seulement s'il est pertinent.
16
- 6. Vérifier si le serveur MCP Living Documentation est disponible avant de créer ou modifier de la documentation.
17
-
18
- Remplacer `DOCS_FOLDER` par le vrai dossier de documentation du projet, par exemple `documentation`, `docs` ou `doc`.
13
+ 3. Lire `DOCS_FOLDER/AI/PROJECT-STACK.md` pour comprendre la stack, l'arborescence utile, les concepts centraux et les conventions structurantes.
14
+ 4. Lire `DOCS_FOLDER/AI/PROJECT-USEFUL-COMMANDS.md` pour connaître les commandes de développement, build, test, lint et setup.
15
+ 5. Lire `memory/MEMORY.md` et charger seulement les fichiers mémoire utiles à la tâche.
16
+ 6. Lire toutes les règles dans `DOCS_FOLDER/AI/rules/*.md`.
17
+ 7. Inspecter les ADR existants : lister `DOCS_FOLDER/ADRS/`, lire d'abord `description` et `tags`, puis ouvrir l'ADR complet seulement s'il est pertinent.
18
+ 8. Vérifier si le MCP `living-documentation` est disponible avant de créer ou modifier de la documentation.
19
19
 
20
20
  ## Rôle du MCP Living Documentation
21
21
 
22
- Le MCP Living Documentation est le canal privilégié pour lire, créer et maintenir la documentation du projet. Quand il est disponible, l'IA doit l'utiliser plutôt que modifier les fichiers Markdown à la main.
22
+ Le MCP `living-documentation` est le canal privilégié pour lire, créer et maintenir la documentation du projet. Quand il est disponible, l'IA doit l'utiliser plutôt que modifier les fichiers Markdown à la main.
23
23
 
24
24
  Utiliser notamment :
25
25
 
@@ -89,6 +89,22 @@ Quand l'IA crée ou met à jour un ADR ou un document technique :
89
89
 
90
90
  Les métadonnées ne sont pas optionnelles pour les documents qui décrivent du code. Si elles ne peuvent pas être mises à jour, l'IA doit le signaler dans sa réponse finale et lister les fichiers à attacher.
91
91
 
92
+ ## Stack et commandes projet
93
+
94
+ `DOCS_FOLDER/AI/PROJECT-STACK.md` contient le résumé opérationnel du projet : stack technique, zones source importantes, concepts centraux et conventions structurantes.
95
+
96
+ `DOCS_FOLDER/AI/PROJECT-USEFUL-COMMANDS.md` contient les commandes réellement utiles : installation, développement local, build, tests, lint, formatage, setup et commandes dangereuses.
97
+
98
+ Ces deux fichiers sont de la documentation vivante. L'IA doit proposer leur mise à jour lorsqu'une tâche rend leur contenu faux, incomplet ou insuffisamment précis.
99
+
100
+ Règles :
101
+
102
+ - garder ces fichiers courts, concrets et orientés action ;
103
+ - ne pas y dupliquer les ADR ;
104
+ - pointer vers les ADR lorsqu'une explication durable existe ;
105
+ - vérifier l'existence d'une commande avant de la documenter ;
106
+ - ne pas modifier silencieusement une convention structurante ou une commande dangereuse : expliquer le changement et attendre validation si le risque est significatif.
107
+
92
108
  ## Règles IA
93
109
 
94
110
  Les règles vivent dans `DOCS_FOLDER/AI/rules/*.md`.
@@ -114,7 +130,7 @@ La mémoire sert aux informations stables et fréquemment réutilisées. Les dé
114
130
 
115
131
  ## Modification des fichiers d'instructions IA
116
132
 
117
- L'IA a le droit de proposer des modifications de `AGENTS.md`, `CLAUDE.md`, `PROJECT-INSTRUCTIONS.md`, `memory/MEMORY.md` ou des règles dans `AI/rules/`.
133
+ L'IA a le droit de proposer des modifications de `AGENTS.md`, `CLAUDE.md`, `PROJECT-INSTRUCTIONS.md`, `PROJECT-STACK.md`, `PROJECT-USEFUL-COMMANDS.md`, `memory/MEMORY.md` ou des règles dans `AI/rules/`.
118
134
 
119
135
  Mais ces fichiers pilotent directement le comportement des assistants IA. Avant de les modifier, l'IA doit :
120
136
 
@@ -0,0 +1,77 @@
1
+ # PROJECT-STACK - Template
2
+
3
+ Ce fichier donne à l'assistant IA une vue rapide et factuelle du projet. Il doit rester court, concret et maintenu en continu.
4
+
5
+ Il ne remplace pas les ADR : il sert à savoir rapidement où regarder, quelles technologies sont en jeu et quels concepts structurent le code. Pour le pourquoi détaillé d'une décision, lire les ADR pertinents.
6
+
7
+ ## Règle de maintenance
8
+
9
+ L'IA doit proposer une mise à jour de ce fichier lorsqu'une tâche :
10
+
11
+ - introduit, retire ou remplace une technologie importante ;
12
+ - modifie une convention structurante ;
13
+ - ajoute ou déplace une zone source importante ;
14
+ - change un concept métier ou technique central ;
15
+ - rend une information ci-dessous fausse ou incomplète.
16
+
17
+ Ne pas documenter ici les détails volatils, les TODO temporaires ou les informations qui appartiennent clairement à un ADR.
18
+
19
+ ## Vue d'ensemble
20
+
21
+ Remplacer ce paragraphe par une description courte du projet :
22
+
23
+ - ce que fait le projet ;
24
+ - pour qui ;
25
+ - où se trouvent le code applicatif, la documentation et les points d'entrée principaux.
26
+
27
+ ## Stack technique
28
+
29
+ Remplir uniquement les lignes qui existent réellement dans le projet. Supprimer les catégories inutiles.
30
+
31
+ - **Langage principal** :
32
+ - **Runtime** :
33
+ - **Framework frontend** :
34
+ - **Framework backend / serveur** :
35
+ - **Base de données / stockage** :
36
+ - **API externes / intégrations** :
37
+ - **Authentification / autorisation** :
38
+ - **Styles / design system** :
39
+ - **Gestion d'état** :
40
+ - **Build / bundler** :
41
+ - **Package manager** :
42
+ - **Tests** :
43
+ - **Lint / formatage** :
44
+ - **Observabilité / logs** :
45
+ - **Déploiement / hébergement** :
46
+
47
+ ## Arborescence source utile
48
+
49
+ Décrire les dossiers ou fichiers que l'IA doit connaître pour s'orienter vite.
50
+
51
+ ```text
52
+ src/ <- code applicatif principal
53
+ tests/ <- tests automatisés
54
+ documentation/ <- documentation Living Documentation, si le dossier porte ce nom
55
+ ```
56
+
57
+ Adapter cette arborescence au projet réel. Ne pas lister tout le dépôt : garder seulement ce qui aide une IA à trouver où intervenir.
58
+
59
+ ## Concepts centraux
60
+
61
+ Lister les concepts qui reviennent souvent dans les tâches.
62
+
63
+ - **Concept 1** : expliquer en une phrase et pointer vers l'ADR ou le document utile.
64
+ - **Concept 2** : expliquer en une phrase et pointer vers l'ADR ou le document utile.
65
+ - **Concept 3** : expliquer en une phrase et pointer vers l'ADR ou le document utile.
66
+
67
+ ## Conventions structurantes
68
+
69
+ Lister les conventions que l'IA doit respecter avant de modifier le code.
70
+
71
+ - Convention de nommage :
72
+ - Organisation des modules :
73
+ - Gestion des erreurs :
74
+ - Gestion de la configuration :
75
+ - Stratégie de test :
76
+
77
+ Si une convention devient durable ou résulte d'un compromis important, créer ou mettre à jour un ADR plutôt que surcharger ce fichier.
@@ -0,0 +1,80 @@
1
+ # PROJECT-USEFUL-COMMANDS - Template
2
+
3
+ Ce fichier décrit les commandes réellement utiles pour travailler sur le projet. Il doit permettre à une IA de choisir la bonne vérification sans deviner.
4
+
5
+ Il doit rester à jour. Une commande fausse coûte plus cher qu'une commande absente.
6
+
7
+ ## Règle de maintenance
8
+
9
+ L'IA doit proposer une mise à jour de ce fichier lorsqu'une tâche :
10
+
11
+ - ajoute, retire ou renomme un script de développement ;
12
+ - change le package manager ;
13
+ - change la commande de build, test, lint ou formatage ;
14
+ - introduit une étape de setup nécessaire ;
15
+ - révèle qu'une commande documentée ne marche plus.
16
+
17
+ Avant d'ajouter une commande, vérifier qu'elle existe réellement dans `package.json`, un Makefile, un script ou la documentation du projet.
18
+
19
+ ## Package manager
20
+
21
+ Indiquer le package manager attendu et la règle associée.
22
+
23
+ ```text
24
+ npm | pnpm | yarn | bun | autre
25
+ ```
26
+
27
+ Si le projet impose un package manager, créer ou mettre à jour une règle dans `AI/rules/`.
28
+
29
+ ## Installation
30
+
31
+ | Commande | Quand l'utiliser | Notes |
32
+ |---|---|---|
33
+ | `npm install` | Après clone ou changement de dépendances | Adapter au package manager réel. |
34
+
35
+ ## Développement local
36
+
37
+ | Commande | Effet | Notes |
38
+ |---|---|---|
39
+ | `npm run dev` | Démarre le serveur local | Préciser le port et les prérequis. |
40
+
41
+ ## Qualité
42
+
43
+ | Commande | Effet | Quand la lancer |
44
+ |---|---|---|
45
+ | `npm run build` | Compile ou bundle le projet | Après changement de code typé, build config ou assets copiés. |
46
+ | `npm test` | Lance les tests | Après changement de comportement. |
47
+ | `npm run lint` | Lance le lint | Si le projet possède un lint. |
48
+ | `npm run format` | Formate le code | Si le projet possède un formateur. |
49
+
50
+ ## Tests ciblés
51
+
52
+ Documenter les commandes qui permettent de vérifier un périmètre sans lancer toute la suite.
53
+
54
+ | Commande | Périmètre |
55
+ |---|---|
56
+ | `npm test -- <pattern>` | Adapter au runner réel. |
57
+
58
+ ## Setup initial
59
+
60
+ Lister les étapes nécessaires après un clone ou une initialisation.
61
+
62
+ ```bash
63
+ # Exemple à remplacer
64
+ cp .env.example .env
65
+ npm install
66
+ ```
67
+
68
+ ## Commandes dangereuses ou coûteuses
69
+
70
+ Lister les commandes qui modifient l'environnement, suppriment des données, lancent un déploiement ou coûtent de l'argent.
71
+
72
+ | Commande | Risque | Règle |
73
+ |---|---|---|
74
+ | `npm run deploy` | Déploiement réel | Demander validation explicite avant exécution. |
75
+
76
+ ## Notes pour l'IA
77
+
78
+ - Lancer la plus petite vérification utile avant de terminer.
79
+ - Si une commande échoue, reporter la commande exacte, le symptôme et l'hypothèse la plus probable.
80
+ - Ne pas inventer de scripts : si une commande manque, le dire et proposer de l'ajouter.
@@ -5,10 +5,12 @@ Ce fichier est le point d'entrée pour Codex et les outils de type agent.
5
5
  Avant toute modification :
6
6
 
7
7
  1. Lire `DOCS_FOLDER/AI/PROJECT-INSTRUCTIONS.md`.
8
- 2. Lire `memory/MEMORY.md` et charger seulement les fichiers mémoire utiles.
9
- 3. Lire les règles dans `DOCS_FOLDER/AI/rules/*.md`.
10
- 4. Inspecter les ADR dans `DOCS_FOLDER/ADRS/` en lisant d'abord `description` et `tags`.
11
- 5. Utiliser le MCP Living Documentation pour créer, mettre à jour et fiabiliser la documentation quand il est disponible.
8
+ 2. Lire `DOCS_FOLDER/AI/PROJECT-STACK.md` pour comprendre la stack, les zones source utiles, les concepts centraux et les conventions structurantes.
9
+ 3. Lire `DOCS_FOLDER/AI/PROJECT-USEFUL-COMMANDS.md` pour connaître les commandes de développement, build, test, lint et setup.
10
+ 4. Lire `memory/MEMORY.md` et charger seulement les fichiers mémoire utiles à la tâche.
11
+ 5. Lire toutes les règles dans `DOCS_FOLDER/AI/rules/*.md`.
12
+ 6. Inspecter les ADR dans `DOCS_FOLDER/ADRS/` en lisant d'abord `description` et `tags`, puis ouvrir l'ADR complet seulement s'il est pertinent.
13
+ 7. Vérifier si le MCP `living-documentation` est disponible et l'utiliser pour créer, mettre à jour et fiabiliser la documentation lorsque la tâche touche une décision, une règle, une commande, la stack ou un document technique.
12
14
 
13
15
  Remplacer `DOCS_FOLDER` par le vrai dossier de documentation du projet.
14
16
 
@@ -23,6 +25,8 @@ Quand le MCP est disponible :
23
25
  - attacher les fichiers source avec `add_metadata` après création ou mise à jour d'un ADR ou document technique ;
24
26
  - appeler `refresh_metadata` lorsque le document est aligné avec le code.
25
27
 
26
- Si le MCP n'est pas disponible, le signaler explicitement dans la réponse finale.
28
+ `PROJECT-STACK.md` et `PROJECT-USEFUL-COMMANDS.md` sont des documents vivants. Si l'agent découvre qu'ils sont faux, incomplets ou obsolètes, il doit proposer ou effectuer leur mise à jour dans la même tâche, sauf instruction contraire de l'utilisateur.
29
+
30
+ Si le MCP n'est pas disponible, le signaler explicitement dans la réponse finale et ne pas prétendre avoir mis à jour les métadonnées ou les hashes Living Documentation.
27
31
 
28
32
  Si une règle ou une instruction projet contredit la demande utilisateur, signaler explicitement le conflit avant de continuer.
@@ -5,10 +5,12 @@ Ce fichier est le point d'entrée pour Claude.
5
5
  Avant toute modification :
6
6
 
7
7
  1. Lire `DOCS_FOLDER/AI/PROJECT-INSTRUCTIONS.md`.
8
- 2. Lire `memory/MEMORY.md` et charger seulement les fichiers mémoire utiles.
9
- 3. Lire les règles dans `DOCS_FOLDER/AI/rules/*.md`.
10
- 4. Inspecter les ADR dans `DOCS_FOLDER/ADRS/` en lisant d'abord `description` et `tags`.
11
- 5. Utiliser le MCP Living Documentation pour créer, mettre à jour et fiabiliser la documentation quand il est disponible.
8
+ 2. Lire `DOCS_FOLDER/AI/PROJECT-STACK.md` pour comprendre la stack, les zones source utiles, les concepts centraux et les conventions structurantes.
9
+ 3. Lire `DOCS_FOLDER/AI/PROJECT-USEFUL-COMMANDS.md` pour connaître les commandes de développement, build, test, lint et setup.
10
+ 4. Lire `memory/MEMORY.md` et charger seulement les fichiers mémoire utiles à la tâche.
11
+ 5. Lire toutes les règles dans `DOCS_FOLDER/AI/rules/*.md`.
12
+ 6. Inspecter les ADR dans `DOCS_FOLDER/ADRS/` en lisant d'abord `description` et `tags`, puis ouvrir l'ADR complet seulement s'il est pertinent.
13
+ 7. Vérifier si le MCP `living-documentation` est disponible et l'utiliser pour créer, mettre à jour et fiabiliser la documentation lorsque la tâche touche une décision, une règle, une commande, la stack ou un document technique.
12
14
 
13
15
  Remplacer `DOCS_FOLDER` par le vrai dossier de documentation du projet.
14
16
 
@@ -23,6 +25,8 @@ Quand le MCP est disponible :
23
25
  - attacher les fichiers source avec `add_metadata` après création ou mise à jour d'un ADR ou document technique ;
24
26
  - appeler `refresh_metadata` lorsque le document est aligné avec le code.
25
27
 
26
- Si le MCP n'est pas disponible, le signaler explicitement dans la réponse finale.
28
+ `PROJECT-STACK.md` et `PROJECT-USEFUL-COMMANDS.md` sont des documents vivants. Si l'agent découvre qu'ils sont faux, incomplets ou obsolètes, il doit proposer ou effectuer leur mise à jour dans la même tâche, sauf instruction contraire de l'utilisateur.
29
+
30
+ Si le MCP n'est pas disponible, le signaler explicitement dans la réponse finale et ne pas prétendre avoir mis à jour les métadonnées ou les hashes Living Documentation.
27
31
 
28
32
  Si une règle ou une instruction projet contredit la demande utilisateur, signaler explicitement le conflit avant de continuer.
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "living-documentation",
3
- "version": "7.58.0",
3
+ "version": "7.59.0",
4
4
  "description": "A CLI tool that serves a local Markdown documentation viewer",
5
5
  "main": "dist/src/server.js",
6
6
  "bin": {