Skip to content

Commit 5a2e001

Browse files
committed
Update CLAUDE.md to emphasize auto-updating documentation and graphify after code modifications
1 parent 5b61108 commit 5a2e001

1 file changed

Lines changed: 5 additions & 2 deletions

File tree

‎CLAUDE.md‎

Lines changed: 5 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -2,6 +2,10 @@
22

33
This file provides guidance to Claude Code (claude.ai/code) when working with code in this repository.
44

5+
## CRITICAL BEHAVIORS (Always Follow)
6+
- **Auto-Update Documentation:** Whenever you modify codebase logic, add new screens, change configuration, or alter the architecture, you **MUST automatically update the corresponding markdown files in the `docs/` directory** in the same set of changes. Do not ask for permission to update the docs; just do it so they never drift from the source code.
7+
- **Auto-Update Graphify:** After modifying code, run `graphify update .` to keep the AST/knowledge graph current (AST-only, no API cost).
8+
59
## graphify
610

711
This project has a knowledge graph at graphify-out/ with god nodes, community structure, and cross-file relationships.
@@ -10,7 +14,6 @@ Rules:
1014
- For codebase questions, first run `graphify query "<question>"` when graphify-out/graph.json exists. Use `graphify path "<A>" "<B>"` for relationships and `graphify explain "<concept>"` for focused concepts. These return a scoped subgraph, usually much smaller than GRAPH_REPORT.md or raw grep output.
1115
- If graphify-out/wiki/index.md exists, use it for broad navigation instead of raw source browsing.
1216
- Read graphify-out/GRAPH_REPORT.md only for broad architecture review or when query/path/explain do not surface enough context.
13-
- After modifying code, run `graphify update .` to keep the graph current (AST-only, no API cost).
1417

1518
## Commands
1619

@@ -36,7 +39,7 @@ There are no runtime environment variables — the app reads no `process.env`/`E
3639

3740
## Documentation
3841

39-
`docs/` is a maintained, current reference — prefer it over re-deriving things from source:
42+
`docs/` is a maintained, current reference — prefer it over re-deriving things from source. **You must keep these files updated when you change the code**:
4043
- `docs/getting-started.md` — setup, run commands, common startup failures
4144
- `docs/architecture.md` — full runtime structure, navigation, data flow, file-by-file
4245
- `docs/project-structure.md` — why each `src/` folder exists and its boundaries

0 commit comments

Comments
 (0)