@cr8rcho/alkahest 0.1.73 → 0.1.74
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/package.json
CHANGED
|
@@ -20,6 +20,13 @@ Placement rule of thumb: what the user *sees* → `components/`; what *happens o
|
|
|
20
20
|
When a topic straddles two layers, pick one as the **main** document and leave a short
|
|
21
21
|
summary + link in the other.
|
|
22
22
|
|
|
23
|
+
## Document shape
|
|
24
|
+
|
|
25
|
+
Title each document with a **classed H1**: `# System — <name>`, `# Component — <name>`,
|
|
26
|
+
`# Feature — <name>`, `# Module — <name>`. The note-map mirror strips the class prefix,
|
|
27
|
+
so the hosted note is titled just `<name>` while the file stays unambiguous in the repo.
|
|
28
|
+
(ADRs have their own H1 shape — see the `adr` skill.)
|
|
29
|
+
|
|
23
30
|
## Bootstrap — when the repo has no docs yet
|
|
24
31
|
|
|
25
32
|
Do NOT try to document everything in one session. The first pass is deliberately small so
|
|
@@ -33,6 +40,10 @@ the user sees a map fast:
|
|
|
33
40
|
4. Add each document to the index in `docs/README.md`, then **mirror to the note maps and
|
|
34
41
|
hand the user the map link** (the mirroring rule lives in this repo's CLAUDE.md).
|
|
35
42
|
|
|
43
|
+
In the first pass, **prefer `modules/`** (plus the one `system/` map) when a topic could
|
|
44
|
+
fit several layers — grow `features/` and `components/` in later sessions, and leave their
|
|
45
|
+
index tables empty until they have documents.
|
|
46
|
+
|
|
36
47
|
Grow the rest incrementally: each later work session adds or updates only the documents its
|
|
37
48
|
code changes touch.
|
|
38
49
|
|
|
@@ -46,6 +57,10 @@ code changes touch.
|
|
|
46
57
|
Remove limitations you fixed; add the ones you introduced.
|
|
47
58
|
- **Overwrite freely** — these documents always describe the present. (ADRs are the
|
|
48
59
|
append-only record; never blend the two.)
|
|
60
|
+
- **Trust the code over connected tools** — an MCP server configured in your session
|
|
61
|
+
(a database MCP, for instance) may be bound to a *different* project than the repo you
|
|
62
|
+
are documenting. Verify the binding before citing anything from it, or read the schema
|
|
63
|
+
from the code instead.
|
|
49
64
|
|
|
50
65
|
## After every code change (checklist)
|
|
51
66
|
|