living-ai-documentation 1.0.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/LICENSE +661 -0
- package/README.fr.md +344 -0
- package/README.md +344 -0
- package/dist/bin/cli.d.ts +3 -0
- package/dist/bin/cli.d.ts.map +1 -0
- package/dist/bin/cli.js +262 -0
- package/dist/bin/cli.js.map +1 -0
- package/dist/src/frontend/accuracy-gauge.js +70 -0
- package/dist/src/frontend/admin.html +1532 -0
- package/dist/src/frontend/annotations.js +585 -0
- package/dist/src/frontend/boot.js +101 -0
- package/dist/src/frontend/config.js +29 -0
- package/dist/src/frontend/confirm-modal.js +82 -0
- package/dist/src/frontend/context.html +1252 -0
- package/dist/src/frontend/dark-mode.js +20 -0
- package/dist/src/frontend/diagram/alignment.js +161 -0
- package/dist/src/frontend/diagram/clipboard.js +187 -0
- package/dist/src/frontend/diagram/constants.js +109 -0
- package/dist/src/frontend/diagram/custom-shapes.js +104 -0
- package/dist/src/frontend/diagram/debug.js +43 -0
- package/dist/src/frontend/diagram/drawio-export.js +649 -0
- package/dist/src/frontend/diagram/edge-panel.js +293 -0
- package/dist/src/frontend/diagram/edge-rendering.js +12 -0
- package/dist/src/frontend/diagram/evidence.js +146 -0
- package/dist/src/frontend/diagram/grid.js +78 -0
- package/dist/src/frontend/diagram/groups.js +102 -0
- package/dist/src/frontend/diagram/history.js +157 -0
- package/dist/src/frontend/diagram/image-name-modal.js +48 -0
- package/dist/src/frontend/diagram/image-upload.js +36 -0
- package/dist/src/frontend/diagram/label-editor.js +115 -0
- package/dist/src/frontend/diagram/link-panel.js +144 -0
- package/dist/src/frontend/diagram/main.js +364 -0
- package/dist/src/frontend/diagram/network.js +2214 -0
- package/dist/src/frontend/diagram/node-panel.js +389 -0
- package/dist/src/frontend/diagram/node-rendering.js +964 -0
- package/dist/src/frontend/diagram/persistence.js +168 -0
- package/dist/src/frontend/diagram/ports.js +421 -0
- package/dist/src/frontend/diagram/selection-overlay.js +387 -0
- package/dist/src/frontend/diagram/state.js +43 -0
- package/dist/src/frontend/diagram/t.js +3 -0
- package/dist/src/frontend/diagram/toast.js +21 -0
- package/dist/src/frontend/diagram/unlock-hold.js +206 -0
- package/dist/src/frontend/diagram/zoom.js +20 -0
- package/dist/src/frontend/diagram-link-modal.js +137 -0
- package/dist/src/frontend/diagram.html +1494 -0
- package/dist/src/frontend/documents.js +479 -0
- package/dist/src/frontend/export.js +338 -0
- package/dist/src/frontend/file-attach.js +178 -0
- package/dist/src/frontend/files-modal.js +243 -0
- package/dist/src/frontend/i18n/en.json +624 -0
- package/dist/src/frontend/i18n/fr.json +624 -0
- package/dist/src/frontend/i18n.js +32 -0
- package/dist/src/frontend/image-paste.js +126 -0
- package/dist/src/frontend/index.html +2806 -0
- package/dist/src/frontend/local-search.js +476 -0
- package/dist/src/frontend/metadata.js +318 -0
- package/dist/src/frontend/misc.js +92 -0
- package/dist/src/frontend/new-doc-modal.js +285 -0
- package/dist/src/frontend/new-folder-modal.js +169 -0
- package/dist/src/frontend/search.js +194 -0
- package/dist/src/frontend/shape-editor.html +685 -0
- package/dist/src/frontend/sidebar-helpers.js +96 -0
- package/dist/src/frontend/sidebar-resize.js +98 -0
- package/dist/src/frontend/sidebar.js +351 -0
- package/dist/src/frontend/snippet-detect.js +25 -0
- package/dist/src/frontend/snippet-table.js +85 -0
- package/dist/src/frontend/snippet-tree.js +94 -0
- package/dist/src/frontend/snippets.js +1146 -0
- package/dist/src/frontend/state.js +46 -0
- package/dist/src/frontend/utils.js +21 -0
- package/dist/src/frontend/validate.js +107 -0
- package/dist/src/frontend/vendor/wordcloud2.js +1187 -0
- package/dist/src/frontend/wordcloud.js +693 -0
- package/dist/src/lib/config.d.ts +26 -0
- package/dist/src/lib/config.d.ts.map +1 -0
- package/dist/src/lib/config.js +195 -0
- package/dist/src/lib/config.js.map +1 -0
- package/dist/src/lib/hash.d.ts +2 -0
- package/dist/src/lib/hash.d.ts.map +1 -0
- package/dist/src/lib/hash.js +18 -0
- package/dist/src/lib/hash.js.map +1 -0
- package/dist/src/lib/metadata.d.ts +31 -0
- package/dist/src/lib/metadata.d.ts.map +1 -0
- package/dist/src/lib/metadata.js +128 -0
- package/dist/src/lib/metadata.js.map +1 -0
- package/dist/src/lib/parser.d.ts +11 -0
- package/dist/src/lib/parser.d.ts.map +1 -0
- package/dist/src/lib/parser.js +111 -0
- package/dist/src/lib/parser.js.map +1 -0
- package/dist/src/lib/status.d.ts +9 -0
- package/dist/src/lib/status.d.ts.map +1 -0
- package/dist/src/lib/status.js +72 -0
- package/dist/src/lib/status.js.map +1 -0
- package/dist/src/mcp/server.d.ts +3 -0
- package/dist/src/mcp/server.d.ts.map +1 -0
- package/dist/src/mcp/server.js +2046 -0
- package/dist/src/mcp/server.js.map +1 -0
- package/dist/src/mcp/tools/diagrams.d.ts +82 -0
- package/dist/src/mcp/tools/diagrams.d.ts.map +1 -0
- package/dist/src/mcp/tools/diagrams.js +594 -0
- package/dist/src/mcp/tools/diagrams.js.map +1 -0
- package/dist/src/mcp/tools/documents.d.ts +44 -0
- package/dist/src/mcp/tools/documents.d.ts.map +1 -0
- package/dist/src/mcp/tools/documents.js +186 -0
- package/dist/src/mcp/tools/documents.js.map +1 -0
- package/dist/src/mcp/tools/git.d.ts +10 -0
- package/dist/src/mcp/tools/git.d.ts.map +1 -0
- package/dist/src/mcp/tools/git.js +217 -0
- package/dist/src/mcp/tools/git.js.map +1 -0
- package/dist/src/mcp/tools/metadata.d.ts +57 -0
- package/dist/src/mcp/tools/metadata.d.ts.map +1 -0
- package/dist/src/mcp/tools/metadata.js +222 -0
- package/dist/src/mcp/tools/metadata.js.map +1 -0
- package/dist/src/mcp/tools/source.d.ts +29 -0
- package/dist/src/mcp/tools/source.d.ts.map +1 -0
- package/dist/src/mcp/tools/source.js +196 -0
- package/dist/src/mcp/tools/source.js.map +1 -0
- package/dist/src/routes/annotations.d.ts +3 -0
- package/dist/src/routes/annotations.d.ts.map +1 -0
- package/dist/src/routes/annotations.js +83 -0
- package/dist/src/routes/annotations.js.map +1 -0
- package/dist/src/routes/browse-source.d.ts +3 -0
- package/dist/src/routes/browse-source.d.ts.map +1 -0
- package/dist/src/routes/browse-source.js +79 -0
- package/dist/src/routes/browse-source.js.map +1 -0
- package/dist/src/routes/browse.d.ts +3 -0
- package/dist/src/routes/browse.d.ts.map +1 -0
- package/dist/src/routes/browse.js +91 -0
- package/dist/src/routes/browse.js.map +1 -0
- package/dist/src/routes/config.d.ts +3 -0
- package/dist/src/routes/config.d.ts.map +1 -0
- package/dist/src/routes/config.js +145 -0
- package/dist/src/routes/config.js.map +1 -0
- package/dist/src/routes/context.d.ts +3 -0
- package/dist/src/routes/context.d.ts.map +1 -0
- package/dist/src/routes/context.js +287 -0
- package/dist/src/routes/context.js.map +1 -0
- package/dist/src/routes/diagrams.d.ts +3 -0
- package/dist/src/routes/diagrams.d.ts.map +1 -0
- package/dist/src/routes/diagrams.js +69 -0
- package/dist/src/routes/diagrams.js.map +1 -0
- package/dist/src/routes/documents.d.ts +11 -0
- package/dist/src/routes/documents.d.ts.map +1 -0
- package/dist/src/routes/documents.js +450 -0
- package/dist/src/routes/documents.js.map +1 -0
- package/dist/src/routes/export.d.ts +3 -0
- package/dist/src/routes/export.d.ts.map +1 -0
- package/dist/src/routes/export.js +280 -0
- package/dist/src/routes/export.js.map +1 -0
- package/dist/src/routes/files.d.ts +3 -0
- package/dist/src/routes/files.d.ts.map +1 -0
- package/dist/src/routes/files.js +180 -0
- package/dist/src/routes/files.js.map +1 -0
- package/dist/src/routes/images.d.ts +3 -0
- package/dist/src/routes/images.d.ts.map +1 -0
- package/dist/src/routes/images.js +49 -0
- package/dist/src/routes/images.js.map +1 -0
- package/dist/src/routes/metadata.d.ts +3 -0
- package/dist/src/routes/metadata.d.ts.map +1 -0
- package/dist/src/routes/metadata.js +131 -0
- package/dist/src/routes/metadata.js.map +1 -0
- package/dist/src/routes/shape-libraries.d.ts +3 -0
- package/dist/src/routes/shape-libraries.d.ts.map +1 -0
- package/dist/src/routes/shape-libraries.js +118 -0
- package/dist/src/routes/shape-libraries.js.map +1 -0
- package/dist/src/routes/wordcloud.d.ts +3 -0
- package/dist/src/routes/wordcloud.d.ts.map +1 -0
- package/dist/src/routes/wordcloud.js +95 -0
- package/dist/src/routes/wordcloud.js.map +1 -0
- package/dist/src/server.d.ts +7 -0
- package/dist/src/server.d.ts.map +1 -0
- package/dist/src/server.js +93 -0
- package/dist/src/server.js.map +1 -0
- package/dist/starter-doc/.living-doc.json +52 -0
- package/dist/starter-doc/ADRS/2026_01_01_[ADR]_example_architecture_decision.md +59 -0
- package/dist/starter-doc/AI/2026_01_01_how_to.md +112 -0
- package/dist/starter-doc/AI/PROJECT-INSTRUCTIONS.md +172 -0
- package/dist/starter-doc/AI/PROJECT-STACK.md +77 -0
- package/dist/starter-doc/AI/PROJECT-USEFUL-COMMANDS.md +80 -0
- package/dist/starter-doc/AI/default/AGENTS.md +31 -0
- package/dist/starter-doc/AI/default/CLAUDE.md +31 -0
- package/dist/starter-doc/AI/default/MEMORY.md +24 -0
- package/dist/starter-doc/AI/rules/no-magic-numbers.md +18 -0
- package/dist/starter-doc/AI/rules/track-current-work.md +23 -0
- package/dist/starter-doc/WORKLOG/current-task.md +57 -0
- package/dist/starter-doc-fr/.living-doc.json +52 -0
- package/dist/starter-doc-fr/ADRS/2026_01_01_[ADR]_example_architecture_decision.md +59 -0
- package/dist/starter-doc-fr/AI/2026_01_01_how_to.md +100 -0
- package/dist/starter-doc-fr/AI/PROJECT-INSTRUCTIONS.md +172 -0
- package/dist/starter-doc-fr/AI/PROJECT-STACK.md +77 -0
- package/dist/starter-doc-fr/AI/PROJECT-USEFUL-COMMANDS.md +80 -0
- package/dist/starter-doc-fr/AI/default/AGENTS.md +31 -0
- package/dist/starter-doc-fr/AI/default/CLAUDE.md +31 -0
- package/dist/starter-doc-fr/AI/default/MEMORY.md +24 -0
- package/dist/starter-doc-fr/AI/rules/no-magic-numbers.md +18 -0
- package/dist/starter-doc-fr/AI/rules/track-current-work.md +23 -0
- package/dist/starter-doc-fr/WORKLOG/current-task.md +57 -0
- package/images/living_documentation.jpg +0 -0
- package/images/readme-extra-files.png +0 -0
- package/images/readme-filename-pattern.png +0 -0
- package/images/readme-intelligent-search-demo.jpg +0 -0
- package/images/readme-sidebar.png +0 -0
- package/package.json +72 -0
|
@@ -0,0 +1,112 @@
|
|
|
1
|
+
# How This AI Context Works
|
|
2
|
+
|
|
3
|
+
This project was initialized by the Living Documentation wizard.
|
|
4
|
+
|
|
5
|
+
The wizard already created the documentation folder and copied this starter.
|
|
6
|
+
|
|
7
|
+
It also copied the AI entry files to the parent folder of the documentation folder when the target files did not exist or were empty:
|
|
8
|
+
|
|
9
|
+
```text
|
|
10
|
+
AGENTS.md
|
|
11
|
+
CLAUDE.md
|
|
12
|
+
memory/MEMORY.md
|
|
13
|
+
```
|
|
14
|
+
|
|
15
|
+
If one of these files already existed with content, the wizard stopped instead of overwriting it.
|
|
16
|
+
|
|
17
|
+
Finally, it exposed these files inside Living Documentation through symbolic links:
|
|
18
|
+
|
|
19
|
+
```text
|
|
20
|
+
<docs-folder>/AI/AGENTS.md -> <project-root>/AGENTS.md
|
|
21
|
+
<docs-folder>/AI/CLAUDE.md -> <project-root>/CLAUDE.md
|
|
22
|
+
<docs-folder>/AI/MEMORY.md -> <project-root>/memory/MEMORY.md
|
|
23
|
+
```
|
|
24
|
+
|
|
25
|
+
In other words, these links do not point to another file inside the documentation folder. They expose, under `AI/`, the real files used by agents at the project root.
|
|
26
|
+
|
|
27
|
+
The internal `AI/default/` template folder is removed from the initialized documentation after these copies and links are created.
|
|
28
|
+
|
|
29
|
+
## What The Files Do
|
|
30
|
+
|
|
31
|
+
`AGENTS.md` is the entry point for Codex and agent-style tools.
|
|
32
|
+
|
|
33
|
+
`CLAUDE.md` is the entry point for Claude.
|
|
34
|
+
|
|
35
|
+
`memory/MEMORY.md` is the project-local memory index.
|
|
36
|
+
|
|
37
|
+
`AI/PROJECT-INSTRUCTIONS.md` is the shared operating guide for every AI assistant working on the project.
|
|
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
|
+
|
|
43
|
+
`AI/rules/*.md` contains reusable rules that AI assistants must apply when they touch matching files.
|
|
44
|
+
|
|
45
|
+
`ADRS/*.md` contains durable decisions. ADRs explain why the project works a certain way.
|
|
46
|
+
|
|
47
|
+
## First-Run Verification
|
|
48
|
+
|
|
49
|
+
Open the **AI Context** page from the main navigation.
|
|
50
|
+
|
|
51
|
+
This page should let you verify:
|
|
52
|
+
|
|
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;
|
|
55
|
+
- that AI rules are visible under `AI/rules/`;
|
|
56
|
+
- that the MCP explorer shows the `living-ai-documentation` server, the `/mcp` endpoint, the available tools, and the prompts.
|
|
57
|
+
|
|
58
|
+
If the MCP explorer does not show tools, the AI assistant cannot use Living Documentation as an active source of truth. It can still propose documentation changes, but it must state that metadata and hashes could not be updated through MCP.
|
|
59
|
+
|
|
60
|
+
## Expected AI Workflow
|
|
61
|
+
|
|
62
|
+
An AI assistant should:
|
|
63
|
+
|
|
64
|
+
1. Read its entry point: `AGENTS.md` or `CLAUDE.md`.
|
|
65
|
+
2. Follow the link to `AI/PROJECT-INSTRUCTIONS.md`.
|
|
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.
|
|
75
|
+
|
|
76
|
+
## Project Instructions
|
|
77
|
+
|
|
78
|
+
The shared instructions are in:
|
|
79
|
+
|
|
80
|
+
```text
|
|
81
|
+
AI/PROJECT-INSTRUCTIONS.md
|
|
82
|
+
```
|
|
83
|
+
|
|
84
|
+
## ADRs
|
|
85
|
+
|
|
86
|
+
The starter includes an ADR example:
|
|
87
|
+
|
|
88
|
+
```text
|
|
89
|
+
ADRS/2026_01_01_[ADR]_example_architecture_decision.md
|
|
90
|
+
```
|
|
91
|
+
|
|
92
|
+
Use it as a template when a significant decision must be recorded.
|
|
93
|
+
|
|
94
|
+
An ADR is appropriate when a change affects architecture, a public contract, a storage format, a workflow, a protocol, or a durable convention. It is not needed for trivial fixes or implementation details that are obvious from code.
|
|
95
|
+
|
|
96
|
+
## Metadata And Reliability
|
|
97
|
+
|
|
98
|
+
Living Documentation can bind a document to source files. Each binding stores a hash of the source file so the reliability gauge can show whether the document may have drifted from the code.
|
|
99
|
+
|
|
100
|
+
When an AI creates or updates an ADR or technical document, it should attach the source files that prove or implement the document. If MCP tools are available, prefer `add_metadata` and `refresh_metadata`.
|
|
101
|
+
|
|
102
|
+
If metadata cannot be updated from the current environment, the AI should say so and list the files that should be attached manually.
|
|
103
|
+
|
|
104
|
+
## Cleanup
|
|
105
|
+
|
|
106
|
+
After setup, remove only what is not useful for your project.
|
|
107
|
+
|
|
108
|
+
Common cleanup:
|
|
109
|
+
|
|
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;
|
|
112
|
+
- keep the ADR example only if you want an in-project template.
|
|
@@ -0,0 +1,172 @@
|
|
|
1
|
+
# PROJECT-INSTRUCTIONS - Living Documentation
|
|
2
|
+
|
|
3
|
+
This file is the shared working contract for AI assistants working on this project. It explains how to integrate Living Documentation into the AI-assisted development workflow.
|
|
4
|
+
|
|
5
|
+
`AGENTS.md` and `CLAUDE.md` are tool-specific entry points. They should stay short and point to this file, which carries the common rules.
|
|
6
|
+
|
|
7
|
+
## Startup Routine
|
|
8
|
+
|
|
9
|
+
Before changing the project:
|
|
10
|
+
|
|
11
|
+
1. Read `AGENTS.md` or `CLAUDE.md`, depending on the tool.
|
|
12
|
+
2. Read this file: `DOCS_FOLDER/AI/PROJECT-INSTRUCTIONS.md`.
|
|
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. Read `DOCS_FOLDER/WORKLOG/current-task.md` if present to resume the state of the current task.
|
|
18
|
+
8. Inspect existing ADRs: list `DOCS_FOLDER/ADRS/`, read only `description` and `tags` first, then open the full ADR only when relevant.
|
|
19
|
+
9. Check whether the Living Documentation MCP server is available before creating or modifying documentation.
|
|
20
|
+
|
|
21
|
+
## Living Documentation MCP
|
|
22
|
+
|
|
23
|
+
The Living Documentation MCP is the preferred channel for reading, creating, and maintaining project documentation. When it is available, the AI must use it instead of editing Markdown files by hand.
|
|
24
|
+
|
|
25
|
+
Use in particular:
|
|
26
|
+
|
|
27
|
+
- `list_documents` to discover existing documents;
|
|
28
|
+
- `read_document` to read a document source;
|
|
29
|
+
- `create_document` or `update_document` to create or correct a document;
|
|
30
|
+
- `list_source_files`, `read_source_file`, and `search_source` to connect documentation to code;
|
|
31
|
+
- `add_metadata` to attach a document to the source files that prove it;
|
|
32
|
+
- `refresh_metadata` to recalculate hashes after updates;
|
|
33
|
+
- `get_accuracy` or equivalent tools to detect drift between documentation and code.
|
|
34
|
+
|
|
35
|
+
If the MCP is not available, the AI may propose documentation changes, but it must explicitly state that metadata and hashes could not be updated.
|
|
36
|
+
|
|
37
|
+
## Continuous Documentation
|
|
38
|
+
|
|
39
|
+
Documentation is not a separate step to do later. It is part of the normal AI-assisted development workflow.
|
|
40
|
+
|
|
41
|
+
At the end of every coherent feature, meaningful refactor, behavioral change, or durable decision, the AI must decide whether documentation should be updated.
|
|
42
|
+
|
|
43
|
+
Create or update a document when the change:
|
|
44
|
+
|
|
45
|
+
- modifies an architecture boundary;
|
|
46
|
+
- introduces or changes a public contract;
|
|
47
|
+
- changes a storage format, protocol, or workflow;
|
|
48
|
+
- adds a convention future changes must follow;
|
|
49
|
+
- makes an existing document incomplete, ambiguous, or wrong;
|
|
50
|
+
- resolves a trade-off that would be hard to infer from code alone.
|
|
51
|
+
|
|
52
|
+
Do not create durable documentation for trivial fixes, mechanical renames, or formatting-only changes.
|
|
53
|
+
|
|
54
|
+
## Progress Tracking
|
|
55
|
+
|
|
56
|
+
The `DOCS_FOLDER/WORKLOG/` folder holds the operational state of in-progress tasks and the resume points between AI assistants. It does not replace ADRs.
|
|
57
|
+
|
|
58
|
+
`DOCS_FOLDER/WORKLOG/current-task.md` is the shared resume point. Every assistant must read it before resuming a task and update it before handing over when it has started, finished, interrupted, or left a known follow-up.
|
|
59
|
+
|
|
60
|
+
The worklog must stay factual and useful for the next agent:
|
|
61
|
+
|
|
62
|
+
- current status;
|
|
63
|
+
- task in progress;
|
|
64
|
+
- in-scope and out-of-scope items if needed;
|
|
65
|
+
- files or areas concerned;
|
|
66
|
+
- verifications performed;
|
|
67
|
+
- remaining verifications;
|
|
68
|
+
- next recommended action.
|
|
69
|
+
|
|
70
|
+
Create a dedicated document under `DOCS_FOLDER/WORKLOG/` for an MVP ticket when more detailed tracking becomes necessary. Durable decisions stay in ADRs.
|
|
71
|
+
|
|
72
|
+
## ADRs
|
|
73
|
+
|
|
74
|
+
ADRs are the log of architecture and design decisions. They should stay short, traceable, and useful for deciding what to change later.
|
|
75
|
+
|
|
76
|
+
When a feature changes a durable decision:
|
|
77
|
+
|
|
78
|
+
1. Search for existing ADRs about the same topic.
|
|
79
|
+
2. If an ADR remains valid, complete or correct it.
|
|
80
|
+
3. If an ADR is replaced, mark it with the exact status `SuperSeeded` or `Partially SuperSeeded` and create a new ADR explaining the new decision.
|
|
81
|
+
4. Never delete a replaced ADR: the history is useful.
|
|
82
|
+
5. In the new ADR, explicitly mention the replaced ADR and why it is no longer enough.
|
|
83
|
+
|
|
84
|
+
The recommended initial status for an AI-created ADR is `To be validated`. A human can later validate it and change it to `Accepted`.
|
|
85
|
+
|
|
86
|
+
Each ADR should include frontmatter useful for discovery:
|
|
87
|
+
|
|
88
|
+
```markdown
|
|
89
|
+
---
|
|
90
|
+
**date:** YYYY-MM-DD
|
|
91
|
+
**status:** To be validated
|
|
92
|
+
**description:** One sentence summarizing the decision and why it matters.
|
|
93
|
+
**tags:** architecture, mcp, metadata
|
|
94
|
+
---
|
|
95
|
+
```
|
|
96
|
+
|
|
97
|
+
## Metadata And Reliability Gauge
|
|
98
|
+
|
|
99
|
+
A Living Documentation document should be linked to the source files that prove what it says. These links are stored as metadata and allow the document reliability score to be calculated.
|
|
100
|
+
|
|
101
|
+
When the AI creates or updates an ADR or technical document:
|
|
102
|
+
|
|
103
|
+
1. Identify the source files that are actually involved.
|
|
104
|
+
2. Attach those files to the document with `add_metadata`.
|
|
105
|
+
3. Avoid attaching overly generic files when a more precise file proves the content better.
|
|
106
|
+
4. After correcting the document, call `refresh_metadata` to recalculate hashes.
|
|
107
|
+
5. If a document remains correct after a cosmetic code change, use `refresh_metadata` to re-baseline the hash without rewriting the document unnecessarily.
|
|
108
|
+
|
|
109
|
+
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.
|
|
110
|
+
|
|
111
|
+
## Project Stack And Commands
|
|
112
|
+
|
|
113
|
+
`DOCS_FOLDER/AI/PROJECT-STACK.md` contains the operational project summary: technical stack, important source areas, core concepts, and structural conventions.
|
|
114
|
+
|
|
115
|
+
`DOCS_FOLDER/AI/PROJECT-USEFUL-COMMANDS.md` contains commands that are actually useful: installation, local development, build, tests, lint, formatting, setup, and dangerous commands.
|
|
116
|
+
|
|
117
|
+
These two files are living documentation. The AI must propose updates when a task makes their content false, incomplete, or insufficiently precise.
|
|
118
|
+
|
|
119
|
+
Rules:
|
|
120
|
+
|
|
121
|
+
- keep these files short, concrete, and action-oriented;
|
|
122
|
+
- do not duplicate ADRs in them;
|
|
123
|
+
- point to ADRs when a durable explanation exists;
|
|
124
|
+
- verify that a command exists before documenting it;
|
|
125
|
+
- do not silently change a structural convention or dangerous command: explain the change and wait for validation when the risk is significant.
|
|
126
|
+
|
|
127
|
+
## AI Rules
|
|
128
|
+
|
|
129
|
+
Rules live in `DOCS_FOLDER/AI/rules/*.md`.
|
|
130
|
+
|
|
131
|
+
Each rule uses frontmatter:
|
|
132
|
+
|
|
133
|
+
- `id` - stable identifier;
|
|
134
|
+
- `title` - short human-readable name;
|
|
135
|
+
- `severity` - `guideline`, `warning`, or `required`;
|
|
136
|
+
- `description` - concise summary;
|
|
137
|
+
- `tags` - themes used for discovery;
|
|
138
|
+
- `appliesTo` - globs describing where the rule applies.
|
|
139
|
+
|
|
140
|
+
Apply every rule whose `appliesTo` patterns match files you touch. If a rule conflicts with the user request or another project instruction, state the conflict explicitly before proceeding.
|
|
141
|
+
|
|
142
|
+
## Memory
|
|
143
|
+
|
|
144
|
+
Memory files live in the project under `memory/`.
|
|
145
|
+
|
|
146
|
+
Do not store project memory in a tool-specific global folder if the user expects project-local memory. Update `memory/MEMORY.md` whenever memory files are added or removed.
|
|
147
|
+
|
|
148
|
+
Memory is for stable, frequently reused context. Durable decisions should instead be written as ADRs.
|
|
149
|
+
|
|
150
|
+
## Changing AI Instruction Files
|
|
151
|
+
|
|
152
|
+
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/`.
|
|
153
|
+
|
|
154
|
+
But these files directly steer AI assistant behavior. Before changing them, the AI must:
|
|
155
|
+
|
|
156
|
+
1. explain to the user what it wants to change;
|
|
157
|
+
2. explain why the change improves the workflow;
|
|
158
|
+
3. state any possible risks;
|
|
159
|
+
4. wait for explicit validation if the change may reduce visibility, remove a rule, weaken a constraint, or make the agent more autonomous.
|
|
160
|
+
|
|
161
|
+
No destructive change to these files should be made silently.
|
|
162
|
+
|
|
163
|
+
## Verification
|
|
164
|
+
|
|
165
|
+
Before finishing a task, run the smallest useful verification:
|
|
166
|
+
|
|
167
|
+
- build command if typed code or build files changed;
|
|
168
|
+
- focused tests if behavior changed;
|
|
169
|
+
- lint or formatting command if the project has one;
|
|
170
|
+
- MCP/documentation verification if ADRs or metadata were created or modified.
|
|
171
|
+
|
|
172
|
+
If a verification cannot be run, explain why.
|
|
@@ -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.
|
|
@@ -0,0 +1,31 @@
|
|
|
1
|
+
# AGENTS.md - Living Documentation
|
|
2
|
+
|
|
3
|
+
This file is the entry point for Codex and agent-style tools.
|
|
4
|
+
|
|
5
|
+
Before making changes:
|
|
6
|
+
|
|
7
|
+
1. Read `DOCS_FOLDER/AI/PROJECT-INSTRUCTIONS.md`.
|
|
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. Read `DOCS_FOLDER/WORKLOG/current-task.md` if present to resume the state of the current task.
|
|
13
|
+
7. Inspect ADRs in `DOCS_FOLDER/ADRS/` by reading `description` and `tags` first, then open the full ADR only when relevant.
|
|
14
|
+
8. Check whether the `living-ai-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.
|
|
15
|
+
|
|
16
|
+
## Living Documentation MCP
|
|
17
|
+
|
|
18
|
+
The Living Documentation server exposes its MCP on `/mcp` with Streamable HTTP transport, for example `http://localhost:4321/mcp` when the server uses the default port.
|
|
19
|
+
|
|
20
|
+
When the MCP is available:
|
|
21
|
+
|
|
22
|
+
- use document tools to read, create, or update documentation;
|
|
23
|
+
- use source tools to inspect code only when documentation is not enough;
|
|
24
|
+
- attach source files with `add_metadata` after creating or updating an ADR or technical document;
|
|
25
|
+
- call `refresh_metadata` once the document is aligned with the code.
|
|
26
|
+
|
|
27
|
+
`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.
|
|
28
|
+
|
|
29
|
+
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.
|
|
30
|
+
|
|
31
|
+
If a rule or project instruction conflicts with the user request, state the conflict explicitly before proceeding.
|
|
@@ -0,0 +1,31 @@
|
|
|
1
|
+
# CLAUDE.md - Living Documentation
|
|
2
|
+
|
|
3
|
+
This file is the entry point for Claude.
|
|
4
|
+
|
|
5
|
+
Before making changes:
|
|
6
|
+
|
|
7
|
+
1. Read `DOCS_FOLDER/AI/PROJECT-INSTRUCTIONS.md`.
|
|
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. Read `DOCS_FOLDER/WORKLOG/current-task.md` if present to resume the state of the current task.
|
|
13
|
+
7. Inspect ADRs in `DOCS_FOLDER/ADRS/` by reading `description` and `tags` first, then open the full ADR only when relevant.
|
|
14
|
+
8. Check whether the `living-ai-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.
|
|
15
|
+
|
|
16
|
+
## Living Documentation MCP
|
|
17
|
+
|
|
18
|
+
The Living Documentation server exposes its MCP on `/mcp` with Streamable HTTP transport, for example `http://localhost:4321/mcp` when the server uses the default port.
|
|
19
|
+
|
|
20
|
+
When the MCP is available:
|
|
21
|
+
|
|
22
|
+
- use document tools to read, create, or update documentation;
|
|
23
|
+
- use source tools to inspect code only when documentation is not enough;
|
|
24
|
+
- attach source files with `add_metadata` after creating or updating an ADR or technical document;
|
|
25
|
+
- call `refresh_metadata` once the document is aligned with the code.
|
|
26
|
+
|
|
27
|
+
`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.
|
|
28
|
+
|
|
29
|
+
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.
|
|
30
|
+
|
|
31
|
+
If a rule or project instruction conflicts with the user request, state the conflict explicitly before proceeding.
|
|
@@ -0,0 +1,24 @@
|
|
|
1
|
+
# Memory Index
|
|
2
|
+
|
|
3
|
+
Always store project memory in the current project's `memory/` folder.
|
|
4
|
+
|
|
5
|
+
Do not write project memory to a tool-specific global folder, for example `~/.claude`.
|
|
6
|
+
|
|
7
|
+
## Recommended Memory Files
|
|
8
|
+
|
|
9
|
+
List the memory files that are actually useful to this project, for example:
|
|
10
|
+
|
|
11
|
+
```text
|
|
12
|
+
memory/project-overview.md
|
|
13
|
+
memory/architecture.md
|
|
14
|
+
memory/testing.md
|
|
15
|
+
memory/domain-language.md
|
|
16
|
+
```
|
|
17
|
+
|
|
18
|
+
## Usage Rule
|
|
19
|
+
|
|
20
|
+
Memory is for stable, frequently reused context.
|
|
21
|
+
|
|
22
|
+
Durable decisions should be written as ADRs under `DOCS_FOLDER/ADRS/`.
|
|
23
|
+
|
|
24
|
+
Update this file when memory files are added, renamed, or removed.
|
|
@@ -0,0 +1,18 @@
|
|
|
1
|
+
---
|
|
2
|
+
id: no-magic-numbers
|
|
3
|
+
title: Avoid magic numbers
|
|
4
|
+
severity: warning
|
|
5
|
+
description: Numeric values with domain meaning must be named constants instead of repeated raw literals.
|
|
6
|
+
tags: ["code-quality", "maintainability"]
|
|
7
|
+
appliesTo: ["src/**/*.ts", "src/frontend/**/*.js"]
|
|
8
|
+
---
|
|
9
|
+
|
|
10
|
+
Numeric values with domain meaning should be named where they are introduced.
|
|
11
|
+
|
|
12
|
+
Prefer a constant whose name explains the intent:
|
|
13
|
+
|
|
14
|
+
```ts
|
|
15
|
+
const DEFAULT_CUSTOM_SHAPE_SIZE = 65;
|
|
16
|
+
```
|
|
17
|
+
|
|
18
|
+
Avoid repeating raw values in code when the value carries product, rendering, sizing, timing, or protocol meaning.
|
|
@@ -0,0 +1,23 @@
|
|
|
1
|
+
---
|
|
2
|
+
id: track-current-work
|
|
3
|
+
title: Track the current task in WORKLOG
|
|
4
|
+
severity: required
|
|
5
|
+
description: AI assistants must read and maintain the current-task worklog to enable reliable handoff between agents.
|
|
6
|
+
tags: ["worklog", "handoff", "ai-agents", "progress", "documentation"]
|
|
7
|
+
appliesTo: ["**/*"]
|
|
8
|
+
---
|
|
9
|
+
|
|
10
|
+
Before resuming or modifying the project, read `DOCS_FOLDER/WORKLOG/current-task.md` if the file exists.
|
|
11
|
+
|
|
12
|
+
When a task is started, interrupted, finished, or left with known follow-ups, update `DOCS_FOLDER/WORKLOG/current-task.md` with:
|
|
13
|
+
|
|
14
|
+
- the current status;
|
|
15
|
+
- the task in progress;
|
|
16
|
+
- the files or areas concerned;
|
|
17
|
+
- the verifications performed;
|
|
18
|
+
- the remaining verifications;
|
|
19
|
+
- the next recommended action.
|
|
20
|
+
|
|
21
|
+
For an MVP ticket that has actually started, create or update a dedicated document under `DOCS_FOLDER/WORKLOG/` if the tracking no longer fits clearly in `current-task.md`.
|
|
22
|
+
|
|
23
|
+
The worklog does not replace ADRs: it describes operational progress and resume points, not durable decisions.
|
|
@@ -0,0 +1,57 @@
|
|
|
1
|
+
---
|
|
2
|
+
**date:** 2026-01-02
|
|
3
|
+
**status:** Idle
|
|
4
|
+
**description:** Shared resume point between AI assistants to track the current task, its status, the files touched, the verifications, and the next action.
|
|
5
|
+
**tags:** worklog, handoff, progress, resume, ai-agents
|
|
6
|
+
---
|
|
7
|
+
|
|
8
|
+
# Current task
|
|
9
|
+
|
|
10
|
+
This document is the shared resume point between AI assistants. Every agent must read it before continuing a task and update it before handing over.
|
|
11
|
+
|
|
12
|
+
## Current status
|
|
13
|
+
|
|
14
|
+
Idle
|
|
15
|
+
|
|
16
|
+
## Current task
|
|
17
|
+
|
|
18
|
+
No application implementation task is currently in progress.
|
|
19
|
+
|
|
20
|
+
## Last action performed
|
|
21
|
+
|
|
22
|
+
Added the progress-tracking convention between AI assistants:
|
|
23
|
+
|
|
24
|
+
- created this current worklog;
|
|
25
|
+
- created the mandatory rule `track-current-work`;
|
|
26
|
+
- added the worklog read step in `AGENTS.md`, `CLAUDE.md` and `PROJECT-INSTRUCTIONS.md`.
|
|
27
|
+
|
|
28
|
+
## Next recommended action
|
|
29
|
+
|
|
30
|
+
Start Ticket 01: initialize the React + TypeScript + Vite + Tailwind frontend project, then update this worklog with the files created, the verifications run, and any resume points.
|
|
31
|
+
|
|
32
|
+
## Files or areas concerned
|
|
33
|
+
|
|
34
|
+
- `AGENTS.md`
|
|
35
|
+
- `CLAUDE.md`
|
|
36
|
+
- `DOCS_FOLDER/AI/PROJECT-INSTRUCTIONS.md`
|
|
37
|
+
- `DOCS_FOLDER/AI/rules/track-current-work.md`
|
|
38
|
+
- `DOCS_FOLDER/WORKLOG/current-task.md`
|
|
39
|
+
- `DOCS_FOLDER/PRODUCT/`
|
|
40
|
+
- `DOCS_FOLDER/TECHNICAL/`
|
|
41
|
+
- `DOCS_FOLDER/ROADMAP/`
|
|
42
|
+
- `DOCS_FOLDER/ADRS/`
|
|
43
|
+
- `DOCS_FOLDER/AI/PROJECT-STACK.md`
|
|
44
|
+
- `DOCS_FOLDER/AI/PROJECT-USEFUL-COMMANDS.md`
|
|
45
|
+
|
|
46
|
+
## Recent verifications
|
|
47
|
+
|
|
48
|
+
- Living Documentation MCP available.
|
|
49
|
+
- `WORKLOG/current-task` visible in the MCP inventory.
|
|
50
|
+
- `AI/rules/track-current-work` visible in the MCP inventory.
|
|
51
|
+
- ADRs created with metadata and accuracy `1`.
|
|
52
|
+
- `PROJECT-STACK` with metadata and accuracy `1`.
|
|
53
|
+
- No ADR below the reliability threshold.
|
|
54
|
+
|
|
55
|
+
## Resume notes
|
|
56
|
+
|
|
57
|
+
The repository does not contain any application code yet. Do not assume the existence of `package.json`, `src/`, npm scripts, tests, or Tailwind configuration before Ticket 01.
|