@nurix/etna 0.20.24 → 0.20.26
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/data/harness-index.json +1 -1
- package/data/harnesses/code/CLAUDE.md +5 -5
- package/data/harnesses/code/agents/bookkeeper.md +1 -1
- package/data/harnesses/code/agents/change-review.md +1 -1
- package/data/harnesses/code/agents/lld-mode.md +1 -1
- package/data/harnesses/code/agents/maintenance.md +7 -9
- package/data/harnesses/code/docs/structure.md +133 -71
- package/data/harnesses/code/harness.json +4 -4
- package/data/harnesses/code/hooks/awareness.mjs +0 -10
- package/data/harnesses/code/hooks/hooks.json +4 -4
- package/data/harnesses/code/hooks/lib/ownership.mjs +4 -2
- package/data/harnesses/code/hooks/lib/sweep.mjs +4 -8
- package/data/harnesses/code/skills/design/components/index.md +1 -1
- package/data/harnesses/code/skills/documentation/SKILL.md +20 -9
- package/data/harnesses/code/skills/documentation/references/frontmatter.md +3 -3
- package/data/harnesses/code/skills/documentation/references/style-guide.md +70 -27
- package/data/harnesses/code/skills/documentation/references/untemplated.md +2 -1
- package/data/harnesses/code/skills/documentation/scripts/doc-lint.mjs +87 -1
- package/data/harnesses/code/skills/documentation/templates/Readme.md +4 -3
- package/data/harnesses/code/skills/documentation/templates/bookkeeping.md +1 -1
- package/data/harnesses/code/skills/documentation/templates/docs-readme.md +15 -36
- package/data/harnesses/code/skills/documentation/templates/doctrine.md +82 -0
- package/data/harnesses/code/skills/documentation/templates/feature.md +31 -123
- package/data/harnesses/code/skills/documentation/templates/handover.md +174 -0
- package/data/harnesses/code/skills/documentation/templates/operations-procedure.md +1 -1
- package/data/harnesses/code/skills/documentation/templates/package.md +28 -94
- package/data/harnesses/code/skills/documentation/templates/root-readme.md +103 -65
- package/data/harnesses/code/skills/documentation/templates/setup.md +138 -0
- package/data/harnesses/code/skills/documentation/templates/system.md +25 -109
- package/data/harnesses/delivery/agents/lld-mode.md +1 -1
- package/data/harnesses/delivery/agents/maintenance.md +7 -9
- package/data/harnesses/delivery/harness.json +2 -2
- package/data/harnesses/delivery/hooks/hooks.json +1 -1
- package/data/harnesses/delivery/skills/documentation/SKILL.md +20 -9
- package/data/harnesses/delivery/skills/documentation/references/frontmatter.md +3 -3
- package/data/harnesses/delivery/skills/documentation/references/style-guide.md +70 -27
- package/data/harnesses/delivery/skills/documentation/references/untemplated.md +2 -1
- package/data/harnesses/delivery/skills/documentation/scripts/doc-lint.mjs +87 -1
- package/data/harnesses/delivery/skills/documentation/templates/Readme.md +4 -3
- package/data/harnesses/delivery/skills/documentation/templates/bookkeeping.md +1 -1
- package/data/harnesses/delivery/skills/documentation/templates/docs-readme.md +15 -36
- package/data/harnesses/delivery/skills/documentation/templates/doctrine.md +82 -0
- package/data/harnesses/delivery/skills/documentation/templates/feature.md +31 -123
- package/data/harnesses/delivery/skills/documentation/templates/handover.md +174 -0
- package/data/harnesses/delivery/skills/documentation/templates/operations-procedure.md +1 -1
- package/data/harnesses/delivery/skills/documentation/templates/package.md +28 -94
- package/data/harnesses/delivery/skills/documentation/templates/root-readme.md +103 -65
- package/data/harnesses/delivery/skills/documentation/templates/setup.md +138 -0
- package/data/harnesses/delivery/skills/documentation/templates/system.md +25 -109
- package/data/harnesses/discussion/harness.json +2 -2
- package/data/harnesses/discussion/hooks/hooks.json +1 -1
- package/data/harnesses/etna/agents/change-review.md +1 -1
- package/data/harnesses/etna/agents/lld-mode.md +1 -1
- package/data/harnesses/etna/agents/maintenance.md +7 -9
- package/data/harnesses/etna/harness.json +2 -2
- package/data/harnesses/etna/hooks/hooks.json +1 -1
- package/data/harnesses/etna/skills/documentation/SKILL.md +20 -9
- package/data/harnesses/etna/skills/documentation/references/frontmatter.md +3 -3
- package/data/harnesses/etna/skills/documentation/references/style-guide.md +70 -27
- package/data/harnesses/etna/skills/documentation/references/untemplated.md +2 -1
- package/data/harnesses/etna/skills/documentation/scripts/doc-lint.mjs +87 -1
- package/data/harnesses/etna/skills/documentation/templates/Readme.md +4 -3
- package/data/harnesses/etna/skills/documentation/templates/bookkeeping.md +1 -1
- package/data/harnesses/etna/skills/documentation/templates/docs-readme.md +15 -36
- package/data/harnesses/etna/skills/documentation/templates/doctrine.md +82 -0
- package/data/harnesses/etna/skills/documentation/templates/feature.md +31 -123
- package/data/harnesses/etna/skills/documentation/templates/handover.md +174 -0
- package/data/harnesses/etna/skills/documentation/templates/operations-procedure.md +1 -1
- package/data/harnesses/etna/skills/documentation/templates/package.md +28 -94
- package/data/harnesses/etna/skills/documentation/templates/root-readme.md +103 -65
- package/data/harnesses/etna/skills/documentation/templates/setup.md +138 -0
- package/data/harnesses/etna/skills/documentation/templates/system.md +25 -109
- package/lib/install/materialize.mjs +18 -14
- package/lib/install/plan.mjs +4 -11
- package/package.json +3 -2
- package/data/harnesses/code/skills/documentation/templates/structure.md +0 -71
- package/data/harnesses/delivery/skills/documentation/templates/structure.md +0 -71
- package/data/harnesses/etna/skills/documentation/templates/structure.md +0 -71
|
@@ -2,67 +2,46 @@
|
|
|
2
2
|
|
|
3
3
|
Truth document. Use for: the entry point for all documentation in a repo. Created during baseline audit.
|
|
4
4
|
|
|
5
|
+
**This file describes directories, never files.** Each section names one folder under `docs/` and says what the folder holds, who reads it and how its files are named — a description of the directory, not of its contents. No per-file rows, no file tree, no `├──` block: the tree is `structure.md`'s, as the authority on placement, and `ls` is the roster. A row per file forces an index edit on every file added, renamed or retired, and the index's own history then records roster churn instead of what the index said — a repo carried 103 commits on `docs/README.md` before this rule, most of them row edits. Each section below names a folder and says what the folder holds and how its files are named; the only files an index may name are the mandated scaffolds (`structure.md`, `operations/setup.md`, `history/CHANGELOG.md`, `history/backlog.md`) and the root `CLAUDE.md`. The repo-root `README.md` routes the team and agents in by intent; this file describes the folders of the docs tree — each links the other once and neither restates the other. `doc-lint` blocks a folder index that links an individual document (`index-lists-files`) or draws a tree (`index-file-tree`).
|
|
6
|
+
|
|
5
7
|
**Link only what exists.** Every row below is a placeholder — drop any whose target the repo does not have. Most `history/` and `architecture/` folders are created on first use, so linking them unconditionally ships a docs index with dead links on day one. An index is a browse page: a link that resolves to nothing is worse than an absent row.
|
|
6
8
|
|
|
7
9
|
```
|
|
8
10
|
# {Project Name} Documentation
|
|
9
11
|
|
|
10
|
-
Technical documentation for {project description}.
|
|
12
|
+
Technical documentation for {project description}. {Two or three sentences: what the product is, its planes or packages, who the docs are for.}
|
|
11
13
|
|
|
12
14
|
> For documentation organization, authority map, and folder rules, see **[structure.md](structure.md)**.
|
|
13
15
|
|
|
14
16
|
---
|
|
15
17
|
|
|
16
|
-
## Quick Links
|
|
17
|
-
|
|
18
|
-
| Document | Description |
|
|
19
|
-
| --------------------------------- | ------------------------------------ |
|
|
20
|
-
| [Structure](structure.md) | Documentation entry point and rules |
|
|
21
|
-
| [Setup](operations/setup.md) | Installation and configuration guide |
|
|
22
|
-
|
|
23
|
-
---
|
|
24
|
-
|
|
25
18
|
## Architecture
|
|
26
19
|
|
|
27
|
-
|
|
28
|
-
|
|
29
|
-
- [system-design.md](architecture/system-design.md) - System overview: subsystems and key flows
|
|
30
|
-
- [domain-model.md](architecture/domain-model.md) - Entities, relationships, state ownership
|
|
31
|
-
- [glossary.md](architecture/glossary.md) - Project vocabulary
|
|
32
|
-
- [non-goals.md](architecture/non-goals.md) - What this system deliberately does not do
|
|
33
|
-
- [decisions/](architecture/decisions/Readme.md) - Architecture Decisions (ADs)
|
|
34
|
-
{list other architecture docs — api.md, security.md — when present}
|
|
35
|
-
|
|
36
|
-
---
|
|
20
|
+
The design layer — [architecture/](architecture/): {what the folder holds — the system overview, steering docs, cross-cutting doctrine, the per-package and per-system documents, and `decisions/` (one Architecture Decision per subject, `AD-NNN-{slug}.md`, status in each file's frontmatter)}.
|
|
37
21
|
|
|
38
22
|
## Features
|
|
39
23
|
|
|
40
|
-
|
|
24
|
+
[features/](features/) — one living reference per feature (how it works today), flat, named `{feature}.md`; each carries `owns:` for the code it speaks for. Find a feature by its name or by the ownership index, never by a row here.
|
|
41
25
|
|
|
42
|
-
|
|
43
|
-
{list all feature docs}
|
|
26
|
+
## Tests
|
|
44
27
|
|
|
45
|
-
|
|
28
|
+
[tests/](tests/) — one behavioral checklist per documented surface, `{feature}.md`, `verifies:` naming the document whose promises it proves.
|
|
46
29
|
|
|
47
30
|
## Operations
|
|
48
31
|
|
|
49
|
-
|
|
32
|
+
[operations/](operations/) — how to set up, run, develop, deploy and recover. Start at [`setup.md`](operations/setup.md) on a new machine; every other procedure is named for its task.
|
|
33
|
+
|
|
34
|
+
## History
|
|
50
35
|
|
|
51
|
-
|
|
52
|
-
{list all operations docs — environment.md when present}
|
|
36
|
+
[history/](history/) — the records: `plans/` (one dated plan per unit of work, frozen at completion), `changelog/` (one entry per unit of work, indexed by [CHANGELOG.md](history/CHANGELOG.md)), `migrations/` (one-shot runbooks), `brainstorms/`, `research/`, and [backlog.md](history/backlog.md).
|
|
53
37
|
|
|
54
|
-
|
|
38
|
+
## Research and memory
|
|
55
39
|
|
|
56
|
-
|
|
40
|
+
[research/](research/) — in-progress brainstorm sessions and standing research. [memory/](memory/) — project memory, one file per agent.
|
|
57
41
|
|
|
58
|
-
|
|
42
|
+
## Notes for this repository
|
|
59
43
|
|
|
60
|
-
-
|
|
61
|
-
- [changelog/](history/changelog/) - Individual changelog entries
|
|
62
|
-
- [plans/](history/plans/) - Implementation plans (frozen at completion)
|
|
63
|
-
- [migrations/](history/migrations/) - One-shot migration runbooks (frozen once executed)
|
|
64
|
-
- [research/](history/research/) - Deep-research artifacts (one folder per topic)
|
|
65
|
-
- [backlog.md](history/backlog.md) - Tracked work items and technical debt
|
|
44
|
+
{The one place project-specific placement facts live, because `structure.md` is the harness's and is overwritten on every refresh: legacy folders kept as frozen provenance, a retired genre whose residue is still on disk, a local exception to a folder rule. One bullet each; delete the section when there are none.}
|
|
66
45
|
|
|
67
46
|
---
|
|
68
47
|
|
|
@@ -0,0 +1,82 @@
|
|
|
1
|
+
# Doctrine Documentation (docs/architecture/common/{concern}.md)
|
|
2
|
+
|
|
3
|
+
Truth document. Use for **one concern the platform handles everywhere**: authentication, authorization, storage, the API protocol, credentials, telemetry. One file per concern, named for the concern. A doctrine document owns no code and carries no `owns:`. A surface declares that it is bound by one through its own `applies:`.
|
|
4
|
+
|
|
5
|
+
**A doctrine document states the design and nothing beneath it** (`references/style-guide.md` § Shape — the model first, the detail after). It is the most stable document in the tree, because it says why the platform is shaped the way it is, and that changes far less often than the code. It explains no mechanism: no function, file, column, cookie attribute, header value or per-route error code, since each of those fails the stability test. The code graph answers what the code does. This document answers why, and which principles any new code in the concern must keep.
|
|
6
|
+
|
|
7
|
+
**Required:**
|
|
8
|
+
|
|
9
|
+
- the frontmatter
|
|
10
|
+
- the opening (the question, the boundary, and the authority sentence)
|
|
11
|
+
- **The model**, ending in numbered principles, each with its reason
|
|
12
|
+
- **The parts**: one table or diagram placing every part in the model, then how the parts relate
|
|
13
|
+
- **one section per part**
|
|
14
|
+
- **For the agent**
|
|
15
|
+
|
|
16
|
+
**Optional:**
|
|
17
|
+
|
|
18
|
+
- an `UNBUILT` block for decided-but-unbuilt intent
|
|
19
|
+
- **Related**
|
|
20
|
+
|
|
21
|
+
Nothing else. Expect one hundred and fifty to three hundred lines; past that, mechanism has usually crept in.
|
|
22
|
+
|
|
23
|
+
```yaml
|
|
24
|
+
---
|
|
25
|
+
type: doctrine # required tooling key
|
|
26
|
+
status: active # required — active | draft
|
|
27
|
+
objects: [principal, credential, device grant] # recommended — the concepts this doctrine governs, by their graph names
|
|
28
|
+
---
|
|
29
|
+
```
|
|
30
|
+
|
|
31
|
+
```
|
|
32
|
+
# {Concern}
|
|
33
|
+
|
|
34
|
+
{The question this concern answers for every request, row or run, in one sentence, bolded — then what it does not answer and which document does. One paragraph.}
|
|
35
|
+
|
|
36
|
+
{The authority sentence: this document states the design, not the code; for what does what, read the code roots in the footer or ask the code graph; where this document and the code disagree on *what*, the code is right; on *why* or a principle, the disagreement is a defect to raise.}
|
|
37
|
+
|
|
38
|
+
## The model
|
|
39
|
+
|
|
40
|
+
### {What the platform owns here, and what it delegates}
|
|
41
|
+
|
|
42
|
+
{The one framing fact a reader needs before anything else — e.g. "NuStack checks identity; it does not own it". Plain words, no addresses.}
|
|
43
|
+
|
|
44
|
+
### {The parties or parts}
|
|
45
|
+
|
|
46
|
+
{Who or what participates, in a short list of one-liners — each named in plain words first, its term of art in parentheses.}
|
|
47
|
+
|
|
48
|
+
### {The axis that organizes them}
|
|
49
|
+
|
|
50
|
+
{The one or two dimensions every part is placed on — e.g. "who issued the proof decides how it is checked". A small table is right here.}
|
|
51
|
+
|
|
52
|
+
### The principles
|
|
53
|
+
|
|
54
|
+
{Numbered invariants that hold across every part. Each one sentence of rule plus its reason. Later sections cite them by number.}
|
|
55
|
+
|
|
56
|
+
## {The parts} — e.g. "The credential families"
|
|
57
|
+
|
|
58
|
+
{One table: each part placed on the model's axes. Then "How the parts relate": what they share, where they meet, what keeps them apart, and the order in which they are tried — each as a bold-led paragraph with its reason. A role-level diagram (mermaid) where the relationships are a flow.}
|
|
59
|
+
|
|
60
|
+
## {Each part, one section per part} — e.g. "How each family works"
|
|
61
|
+
|
|
62
|
+
### {A part, named for who meets it} — e.g. "A person in a browser"
|
|
63
|
+
|
|
64
|
+
{Why the part exists, then the decisions it rests on, each with its reason, citing principles by number. A sequence diagram at role level where the part is a flow. Detail that a person or test can check is welcome; detail that only restates the code is not.}
|
|
65
|
+
|
|
66
|
+
## For the agent
|
|
67
|
+
|
|
68
|
+
{Pointers, not an inventory: the objects with one line each; the code roots as directories; any cross-cutting seam by name; the neighbouring doctrine with a purpose each.}
|
|
69
|
+
```
|
|
70
|
+
|
|
71
|
+
### Marking what is decided and unbuilt
|
|
72
|
+
|
|
73
|
+
Code cannot reveal what it does not yet do, so decided-but-unbuilt intent is one of the few places a doctrine document records something the code does not. Wrap it in `<!-- UNBUILT:START — {what, and the evidence it is not built} -->` … `<!-- UNBUILT:END -->`, in plain words. A design decided *against* carries no marker.
|
|
74
|
+
|
|
75
|
+
### What a doctrine document is not
|
|
76
|
+
|
|
77
|
+
| It is not | That is |
|
|
78
|
+
| --- | --- |
|
|
79
|
+
| A tour of the code that implements the concern | The code graph |
|
|
80
|
+
| The catalog of routes, error codes or variables | An API reference or environment registry |
|
|
81
|
+
| The one feature that happens to use the concern most | That feature's own document, which `applies:` this one |
|
|
82
|
+
| The story of how the concern got this way | A decision record (`decisions/`) for the why, and the changelog for the when |
|
|
@@ -1,151 +1,59 @@
|
|
|
1
|
-
# Feature Documentation
|
|
1
|
+
# Feature Documentation (docs/features/{feature}.md)
|
|
2
2
|
|
|
3
|
-
Truth document. Use for: every feature in `docs/features
|
|
3
|
+
Truth document. Use for: every feature in `docs/features/` — something a person points at: an address, a command family, a named control. One file per feature, cut by the objects it designs, never by the code's routers, tables, plans or packages. The file persists from design (`status: draft`) to live reference (`status: active`).
|
|
4
4
|
|
|
5
|
-
**
|
|
5
|
+
**A document is read by people, and its footer is for the agent** (`references/style-guide.md` § Documents are read by people). The body is plain English a newcomer reads top to bottom: what the thing is, why it is shaped that way, how a person meets it, what it promises. Every computable fact — columns, vocabularies, foreign keys, writers, routes, guards, codes, files — is the code graph's (`docs/architecture/systems/knowledge-layer.md`); a hand-typed copy is the defect this genre removes. The only code the body names is a cross-cutting seam the graph would not lead a reader to from the feature's own files: a middleware, a gate, a hook, a scheduler, a shared store. Everything else by plain name. Identifiers the graph cannot find from the roots live in the footer.
|
|
6
6
|
|
|
7
|
-
|
|
7
|
+
**A feature document runs deepest toward its end** (`references/style-guide.md` § Shape — the model first, the detail after). The opening and Why it exists are the model; How it works is the journey; **What it promises** goes as deep as the behaviour does: every state the surface can be in, every edge case, what a refusal tells the person, the exact wording wherever the wording itself is promised. That depth is earned because a person or a test checks it and the code cannot state it as intent. It still stops before mechanism: a promise reads "a removed membership shows a panel, not a redirect, because nothing can restore it", never which route answers it.
|
|
8
|
+
|
|
9
|
+
**Required:** the frontmatter, the goal line, **Why it exists**, **How it works**, **What it promises**, **For the agent**. **What was decided** once any choice was made the code cannot explain. **Known gaps** only when there is one. Nothing else — `doc-lint` blocks the retired mechanism sections (`mechanism-section`) and warns on identifiers in the body (`body-identifier`), on a section that is a list rather than prose (`list-not-prose`), and on three bold-led bullets in a row (`formula-run`). Forty to a hundred and twenty lines.
|
|
8
10
|
|
|
9
11
|
```yaml
|
|
10
12
|
---
|
|
11
|
-
|
|
12
|
-
module: billing # optional — single bounded-context label; omit if cross-cutting
|
|
13
|
-
keywords: [invoice, pdf] # required — discovery terms
|
|
13
|
+
type: feature # required tooling key — preserve, never narrate
|
|
14
14
|
status: active # required — active | draft | deprecated
|
|
15
|
-
|
|
16
|
-
|
|
17
|
-
|
|
15
|
+
objects: [device, credential grant] # required — the product objects this document designs, by their graph names
|
|
16
|
+
owns: ["packages/studio/src/server/routes/devices.ts"] # required until the graph computes ownership — the code this document speaks for; narrower glob wins
|
|
17
|
+
module: identity # optional — one bounded-context label
|
|
18
|
+
applies: [docs/architecture/common/security.md] # optional — doctrine this surface is BOUND by
|
|
18
19
|
---
|
|
19
20
|
```
|
|
20
21
|
|
|
21
|
-
> Declare the code paths it owns in its `owns:` frontmatter — projected at Draft, confirmed against real code at Active.
|
|
22
|
-
|
|
23
22
|
```
|
|
24
|
-
# {Feature
|
|
25
|
-
|
|
26
|
-
<!-- Lifecycle lives in the frontmatter `status:` key (active | draft | deprecated) — the single source of truth. Don't restate it in the body. -->
|
|
27
|
-
**Plan:** [history/plans/YYYY-MM-DD-feature-name.md](../history/plans/YYYY-MM-DD-feature-name.md) <!-- added once a plan exists -->
|
|
28
|
-
|
|
29
|
-
## Goal
|
|
30
|
-
|
|
31
|
-
One sentence. What this feature accomplishes, in user-facing terms.
|
|
32
|
-
|
|
33
|
-
## Goals & Non-Goals
|
|
34
|
-
|
|
35
|
-
**In scope**
|
|
36
|
-
- Bullet 1
|
|
37
|
-
- Bullet 2
|
|
38
|
-
|
|
39
|
-
**Out of scope**
|
|
40
|
-
- Bullet 1
|
|
41
|
-
|
|
42
|
-
## Background
|
|
43
|
-
|
|
44
|
-
Why this feature exists. The user need, the business trigger, the constraint that pushed it above the line. One paragraph.
|
|
45
|
-
|
|
46
|
-
(For Product-level work, also include: problem statement, key hypotheses, open questions.)
|
|
47
|
-
|
|
48
|
-
## Approach
|
|
49
|
-
|
|
50
|
-
High-level shape of the solution. ASCII diagram if it helps. Implementation specifics belong in the plan.
|
|
51
|
-
|
|
52
|
-
## Affected Modules
|
|
53
|
-
|
|
54
|
-
(From lld-mode research) Files, routes, components, slices this feature involves. Group by module.
|
|
55
|
-
|
|
56
|
-
| Module | Path | Role in this feature |
|
|
57
|
-
|--------|------|----------------------|
|
|
23
|
+
# {Feature name}
|
|
58
24
|
|
|
59
|
-
|
|
25
|
+
{One sentence: what this lets a person do.}
|
|
60
26
|
|
|
61
|
-
|
|
27
|
+
## Why it exists
|
|
62
28
|
|
|
63
|
-
|
|
29
|
+
{The need, the trigger, the constraint; what it is deliberately not for and why. Prose, one or two paragraphs. An AD is cited by number for the reasoning it holds, never restated.}
|
|
64
30
|
|
|
65
|
-
|
|
31
|
+
## How it works
|
|
66
32
|
|
|
67
|
-
|
|
33
|
+
{The feature as a person meets it, start to finish, present tense, plain words: what they see, what happens, what refuses them and what they are told. Introduce each term of art the first time. Name code only at a cross-cutting seam — "every request passes the organization gate before this page is reached (`requireAuth`)" — and nothing else. No columns, routes, guards, functions, files or diagrams: that is the graph's.}
|
|
68
34
|
|
|
69
|
-
|
|
35
|
+
## What was decided
|
|
70
36
|
|
|
71
|
-
|
|
72
|
-
|-----------------|---------------------|------------|
|
|
37
|
+
{The choices the code cannot explain, as two to four themed paragraphs. A rejected alternative is named only where a reader would reach for it. No formula; no bullet per decision.}
|
|
73
38
|
|
|
74
|
-
##
|
|
39
|
+
## What it promises
|
|
75
40
|
|
|
76
|
-
|
|
41
|
+
{The guarantees and refusals a person or a test can check, grouped by theme, as short paragraphs — or a short list only where the items are genuinely parallel one-liners. Positive where possible. This is the deepest section: each state, edge case and refusal the person can meet, and the wording where it is promised. A table of states is right when the states are genuinely parallel.}
|
|
77
42
|
|
|
78
|
-
##
|
|
43
|
+
## Known gaps
|
|
79
44
|
|
|
80
|
-
|
|
81
|
-
**Goal:** What it accomplishes
|
|
82
|
-
**Input:**
|
|
83
|
-
- `param1` (type) - Description
|
|
84
|
-
- `param2` (type) - Description
|
|
85
|
-
**Output:** Return type and shape
|
|
86
|
-
**Side Effects:** DB writes, API calls, state updates
|
|
45
|
+
{One paragraph, only when the code does not keep something the document would otherwise promise. What is missing and what it would take; the backlog row carries the rest.}
|
|
87
46
|
|
|
88
|
-
|
|
89
|
-
**Goal:** What it provides
|
|
90
|
-
**Returns:** `{ data, loading, error }`
|
|
91
|
-
**Triggers:** On mount, on change, manual
|
|
47
|
+
## For the agent
|
|
92
48
|
|
|
93
|
-
|
|
94
|
-
|
|
95
|
-
**Frontend (at persistence):**
|
|
96
|
-
{
|
|
97
|
-
"data": [],
|
|
98
|
-
"changes": { "added": [], "updated": [], "removed": [] }
|
|
99
|
-
// "cache": {} // UNUSED: dead key; kept so old persisted state rehydrates
|
|
100
|
-
}
|
|
101
|
-
|
|
102
|
-
**Storage:** localStorage `app_state`
|
|
103
|
-
|
|
104
|
-
**Backend:**
|
|
105
|
-
export const resources = pgTable('resources', {
|
|
106
|
-
id: text('id').primaryKey(),
|
|
107
|
-
data: jsonb('data'),
|
|
108
|
-
// oldField: text('old_field'), // UNUSED: dead column; nothing reads it
|
|
109
|
-
});
|
|
110
|
-
|
|
111
|
-
**API Shape:**
|
|
112
|
-
{ "status": 1, "data": {...} }
|
|
113
|
-
|
|
114
|
-
## Redux (if applicable)
|
|
115
|
-
|
|
116
|
-
**Slice:** `sliceName`
|
|
117
|
-
|
|
118
|
-
**Actions:**
|
|
119
|
-
- `setData(payload)` - Replace all data
|
|
120
|
-
- `upsertItem(item)` - Add or update single item
|
|
121
|
-
|
|
122
|
-
**Selectors:**
|
|
123
|
-
- `selectAll(state)` → `Array<Item>`
|
|
124
|
-
- `selectById(state, id)` → `Item | undefined`
|
|
125
|
-
|
|
126
|
-
## Files
|
|
127
|
-
|
|
128
|
-
- `src/path/to/main.js` - Core logic
|
|
129
|
-
- `src/path/to/hooks.js` - React hooks
|
|
130
|
-
|
|
131
|
-
## Open Questions
|
|
132
|
-
|
|
133
|
-
- Question — who decides, by when
|
|
134
|
-
- (Resolved questions: fold the resolution into Background.)
|
|
135
|
-
|
|
136
|
-
## Risks
|
|
137
|
-
|
|
138
|
-
- Risk — likelihood / impact / mitigation
|
|
49
|
+
Objects: {object} — {one plain-words line}; {object} — {…}. Pages {`/…`}. Code roots {`packages/…/src/…/`} — directories, where the graph should start. Seams {`name`} only where the roots would not lead to them. Checklist `tests/{feature}.md`. See also {neighbour} ({why}), {neighbour} ({why}). No tables, routes or symbol rosters — those are the graph's.
|
|
139
50
|
```
|
|
140
51
|
|
|
141
|
-
###
|
|
142
|
-
|
|
143
|
-
Sections fill in across the feature's lifecycle. No template swap — they accumulate in place.
|
|
52
|
+
### Lifecycle
|
|
144
53
|
|
|
145
|
-
| When |
|
|
146
|
-
| --- | --- |
|
|
147
|
-
|
|
|
148
|
-
|
|
|
149
|
-
| Status: Draft → Active (implementation lands) | Architecture, Key Functions, State, Redux, Files; `owns:` globs confirmed against real code | Main agent (from actual code) |
|
|
54
|
+
| When | What is written |
|
|
55
|
+
| --- | --- |
|
|
56
|
+
| `status: draft` (design) | goal, Why it exists, What was decided, What it promises (with gaps named), For the agent; the LLD research goes to the plan |
|
|
57
|
+
| `status: active` | How it works written from the shipped surface; `owns:` confirmed against real code |
|
|
150
58
|
|
|
151
|
-
|
|
59
|
+
A feature whose code is gone is deleted, or `status: deprecated` with its footer pointing at what replaced it.
|
|
@@ -0,0 +1,174 @@
|
|
|
1
|
+
# Hand-over (`docs/history/handovers/YYYY-MM-DD-{slug}.md`)
|
|
2
|
+
|
|
3
|
+
Record. Use for: the account an **unattended or multi-session build** leaves the person who owns it — written by the orchestrating session as its last act, before the owner's first decision, read in one sitting. It is a **decision queue, an undo manual and a resume file**, in that order: is it done · what must I decide today · what escaped the repository and how do I undo it · can I see it working · what was decided for me and how do I overturn it · what is red and whose it is. Everything below the divider is for the next session, not the owner. It is not a pull-request description (which argues for a diff), not a changelog entry (which carries refinement context) and not a plan (which is frozen). It is mutable while `status: open` — a successor that re-proves a state line corrects it in place and appends one Timeline row — and **freezes when the owner has acted on § 1 (`status: accepted`)**; a correction after that is a new dated hand-over linking back. Raw artefacts (plans, hand-offs, notes) live in a same-named folder beside it.
|
|
4
|
+
|
|
5
|
+
Required: **Verdict**, **Decide today**, **Live-world ledger** (even when empty), **See it work**, **Decided for you**, **Red board**, **What was built**, **Proof**, **State**, **Open loops**, **Artefacts & mandate**. Optional: Left alone, Discoveries, Debt, Cost, Timeline.
|
|
6
|
+
|
|
7
|
+
**Reading order is act → verify → understand.** Owner half, ~20 minutes: Verdict (1) · § 1 (2) · § 2 (2) · § 3 (10, at the product) · § 4 (3) · § 5–6 (2). Successor half, read when the job arrives: § 8–14 (~10).
|
|
8
|
+
|
|
9
|
+
````markdown
|
|
10
|
+
---
|
|
11
|
+
type: handover
|
|
12
|
+
status: {open | accepted}
|
|
13
|
+
date: {YYYY-MM-DD}
|
|
14
|
+
as_of: {YYYY-MM-DDTHH:MM±TZ}
|
|
15
|
+
as_of_commit: {sha} # every § 9 claim is true of THIS commit and no other
|
|
16
|
+
verdict: {done | done-needs-calls | partial | stopped-at-budget | failed}
|
|
17
|
+
decide_today: {N} irreversible_acts: {N} decisions: {N} red_mine: {N} open_loops: {N}
|
|
18
|
+
deployed:
|
|
19
|
+
- { plane: {dev|staging|production}, artifact: {name}, version: "{id}", by: {automatic|manual}, verify: "{command}" }
|
|
20
|
+
prs:
|
|
21
|
+
- { n: {N}, base: {branch}, state: {open|draft|merged}, action: "{what the owner does}" }
|
|
22
|
+
---
|
|
23
|
+
|
|
24
|
+
# Hand-over — {what was built}, {YYYY-MM-DD}
|
|
25
|
+
|
|
26
|
+
**{VERDICT TOKEN}.** {One sentence in the product's words: what exists and what a person can now do.}
|
|
27
|
+
|
|
28
|
+
| | |
|
|
29
|
+
| --- | --- |
|
|
30
|
+
| Built | {N} units · {N} plans · ledger rows {N}, discharged {N}, blocked {N} |
|
|
31
|
+
| Proof | {N} tests pass / {N} fail — on `{sha}`, verified {HH:MM} |
|
|
32
|
+
| Decide today | **{N}** — § 1 |
|
|
33
|
+
| Touched the live world | **{N}** acts, **{N}** you cannot undo — § 2 |
|
|
34
|
+
| Red | {N} mine · {N} pre-existing · {N} environment — § 5 |
|
|
35
|
+
| See it work | {N} min — § 3 |
|
|
36
|
+
| Taken alone | {N} decisions, {N} stops filed of {N} — § 4 |
|
|
37
|
+
|
|
38
|
+
**Start here:** `{the one command that brings the reader's machine to the state everything below describes}`
|
|
39
|
+
**If you only act on one thing:** {act} — by {YYYY-MM-DD}, or {consequence}.
|
|
40
|
+
|
|
41
|
+
## 1. Decide today
|
|
42
|
+
|
|
43
|
+
| # | Decision or act | Why today | If you say nothing | Decide by | Do it (exact) | Evidence |
|
|
44
|
+
| --- | --- | --- | --- | --- | --- | --- |
|
|
45
|
+
| 1 | {one line, no mechanism} | {what a week costs} | {the outcome silence produces} | {date} | `{command}` / {PR link} / {UI path} | `{path:line · sha · PR}` |
|
|
46
|
+
|
|
47
|
+
## 2. Live-world ledger
|
|
48
|
+
|
|
49
|
+
Everything that left the repository, hardest to undo first. Verified {HH:MM}.
|
|
50
|
+
|
|
51
|
+
| # | Act (past tense, dated) | Target (system + id) | Command | Reversible | Undo — exact | Evidence / backup + expiry |
|
|
52
|
+
| --- | --- | --- | --- | --- | --- | --- |
|
|
53
|
+
| 1 | {what was done, {YYYY-MM-DD HH:MM}} | {named system} | `{exact}` | {no / with loss / yes} | `{command}` or {runbook path} — {or "forward only: …"} | {artefact · where · when it expires} |
|
|
54
|
+
|
|
55
|
+
**Did not happen, and the proof:** {claim} — `{command}`.
|
|
56
|
+
|
|
57
|
+
## 3. See it work in ten minutes
|
|
58
|
+
|
|
59
|
+
**Before you start:** `{command}` · **Sign in as:** {who} · **Total:** {N} min
|
|
60
|
+
|
|
61
|
+
| # | Do (URL → click) | You should see | It proves | If not |
|
|
62
|
+
| --- | --- | --- | --- | --- |
|
|
63
|
+
| 1 | {url} → {action} | {an observable a person can be wrong about} | {unit from § 6} | {§ 5 row, or "file it — new"} |
|
|
64
|
+
|
|
65
|
+
## 4. Decided for you
|
|
66
|
+
|
|
67
|
+
Each was taken because waiting would have stopped the run. Sorted by cost to reverse.
|
|
68
|
+
|
|
69
|
+
| # | I decided | Instead of | Why | Authority | Landed at | Overturn — exact | If you say nothing | Hardens when |
|
|
70
|
+
| --- | --- | --- | --- | --- | --- | --- | --- | --- |
|
|
71
|
+
| D-1 | {the ruling} | {the alternative, fairly} | {the constraint} | {owner said so HH:MM "…" / auto-ruled as recommended / taken alone — by {agent · model}} | `{file:line}` | `{edit or command}` | {default} | {event} |
|
|
72
|
+
|
|
73
|
+
*Bulk: {N} per-plan questions ruled `as recommended, overturnable` — index at `{path}`. Only rows costing more than one commit to reverse are listed.*
|
|
74
|
+
|
|
75
|
+
## 5. Red board
|
|
76
|
+
|
|
77
|
+
| What's red | Where | Mine? | Proof | Blocks | Next step + owner |
|
|
78
|
+
| --- | --- | --- | --- | --- | --- |
|
|
79
|
+
| {test or command} | `{file:line}` | {mine / pre-existing / environment} | `{the command or stash that settled it}` | {what it stops, or nothing} | {act} — {who} |
|
|
80
|
+
|
|
81
|
+
## 6. What was built
|
|
82
|
+
|
|
83
|
+
| Unit | What it does for a person | Landed | Proof |
|
|
84
|
+
| --- | --- | --- | --- |
|
|
85
|
+
| {name} | {one clause, behaviour before mechanism} | {branch · PR · release} | {suite + counts, or "driven only", or empty} |
|
|
86
|
+
|
|
87
|
+
## 7. Left alone
|
|
88
|
+
|
|
89
|
+
| Thing | State | Why untouched |
|
|
90
|
+
| --- | --- | --- |
|
|
91
|
+
|
|
92
|
+
---
|
|
93
|
+
|
|
94
|
+
*Everything above is for the owner. Everything below is for the next session.*
|
|
95
|
+
|
|
96
|
+
## 8. Proof
|
|
97
|
+
|
|
98
|
+
| Unit | Promise (clause) | Code @ | Pinned @ | Independent? | Rows p/o/b | Gap |
|
|
99
|
+
| --- | --- | --- | --- | --- | --- | --- |
|
|
100
|
+
| {plan} | {ruling n — five words} | `{sha7}` | `{sha7}` | {yes / **no — {who did both}**} | {n}/{n}/{n} | {G-n / —} |
|
|
101
|
+
|
|
102
|
+
| # | Claim that is not proven | Why | What would prove it | Sev |
|
|
103
|
+
| --- | --- | --- | --- | --- |
|
|
104
|
+
| G-1 | {stated as the build would state it} | {blocked row / never driven / self-authored pin / no suite on this head / not recorded} | `{exact command}` | P{0-3} |
|
|
105
|
+
|
|
106
|
+
## 9. State
|
|
107
|
+
|
|
108
|
+
Present tense; every row true of `as_of_commit`, and every row re-provable by its own command.
|
|
109
|
+
|
|
110
|
+
| Repo · branch | HEAD | vs upstream | Working tree | Worktrees | Re-prove |
|
|
111
|
+
| --- | --- | --- | --- | --- | --- |
|
|
112
|
+
|
|
113
|
+
| Plane | Artifact | Version | Deployed by | Re-prove |
|
|
114
|
+
| --- | --- | --- | --- | --- |
|
|
115
|
+
|
|
116
|
+
| Store | Env | Last destructive act | Backup + expiry | Re-prove |
|
|
117
|
+
| --- | --- | --- | --- | --- |
|
|
118
|
+
|
|
119
|
+
| Process / connection / token | Where | State | Check or stop |
|
|
120
|
+
| --- | --- | --- | --- |
|
|
121
|
+
|
|
122
|
+
## 10. Open loops
|
|
123
|
+
|
|
124
|
+
| # | Loop | Whose | Next command or ask | Blocked by | Evidence |
|
|
125
|
+
| --- | --- | --- | --- | --- | --- |
|
|
126
|
+
| L-1 | {present tense} | {session / owner / external} | `{command}` or {the question, with the default in force} | {id / —} | `{path:line}` |
|
|
127
|
+
|
|
128
|
+
## 11. Discoveries — do not pay for these twice
|
|
129
|
+
|
|
130
|
+
| # | Trap | The truth | Cost paid | Guard |
|
|
131
|
+
| --- | --- | --- | --- | --- |
|
|
132
|
+
| X-1 | {what it looks like from outside} | {present-tense fact} | {hours / runs} | `{command}` or `none — {what would hold it}` |
|
|
133
|
+
|
|
134
|
+
## 12. Debt and can wait
|
|
135
|
+
|
|
136
|
+
| # | What | Why not now | Re-open when | Parked at |
|
|
137
|
+
| --- | --- | --- | --- | --- |
|
|
138
|
+
| T-1 | {one line} | {the ruling} | {a trigger, not a date} | `{backlog row · issue · path:line}` |
|
|
139
|
+
|
|
140
|
+
## 13. Cost
|
|
141
|
+
|
|
142
|
+
**Wall-clock:** {Nh Nm} ({start} → {end}) · **unattended:** {Nh} · **Agents:** {N} · **Tokens:** {N | unmeasured — {what would measure it}} · **Rework:** {what was thrown away} · **Stops filed:** {N} of {N}
|
|
143
|
+
|
|
144
|
+
## 14. Artefacts & mandate
|
|
145
|
+
|
|
146
|
+
| Path | Holds | Volatile | Safe to delete after |
|
|
147
|
+
| --- | --- | --- | --- |
|
|
148
|
+
|
|
149
|
+
**Corpus:** {tracked at `{path}` @ {sha} | **UNTRACKED at `{path}` — {what would durably hold it}**}
|
|
150
|
+
**May, alone:** {one line each} · **Must file or ask:** {one line each} · **Never:** {one line each}
|
|
151
|
+
|
|
152
|
+
## 15. Timeline
|
|
153
|
+
|
|
154
|
+
<!-- Append only. Never rewritten. -->
|
|
155
|
+
|
|
156
|
+
- {YYYY-MM-DD HH:MM} — {event} (`{sha7}` / PR #{n})
|
|
157
|
+
````
|
|
158
|
+
|
|
159
|
+
## Field rules
|
|
160
|
+
|
|
161
|
+
- **Verdict (≤14 lines).** One token from the closed set — `DONE` · `DONE, NEEDS YOUR CALLS` · `PARTIAL` · `STOPPED AT BUDGET` · `FAILED` — first in the body; a paragraph before it is a format violation. The scoreboard is always the same seven rows in that order, and a zero is written `0` — `Touched the live world: 0` is one of the most valuable lines the file can carry. `Start here` is exactly one command.
|
|
162
|
+
- **§ 1 Decide today (≤7 rows).** Owner-only acts, sorted by cost of deferral descending. `Do it (exact)` is a command, a link or a literal UI path — `git revert -m 1 {sha}`, never "revert the merge". `If you say nothing` is mandatory and honest. **A decision has an alternative and belongs in § 4; an act outside the repository with no alternative is a chore and belongs here.**
|
|
163
|
+
- **§ 2 Live-world ledger.** Required even when empty — `none — nothing left the repository`, with the command that proves it. Sorted hardest-to-undo first, never chronologically. `Reversible` takes three values: `no` states what now exists in the world, `with loss` names what is lost, `yes` carries the command. An act reversible only forward (redeploy, reseed, a superseding publish) is `no`, and the forward path goes in `Undo`. A backup states its expiry; copying a volatile backup somewhere durable is row 1 of § 1.
|
|
164
|
+
- **§ 3 See it work (≤6 steps, ≤10 min).** Every `You should see` is an observable a person can be wrong about — a number, a named control, a status code — never "the page loads". It is the only check the owner performs with his own eyes rather than on the build's word.
|
|
165
|
+
- **§ 4 Decided for you (≤10 rows).** Sorted by cost to reverse. `Authority` takes exactly three values — the owner said so (with the words and the time) · auto-ruled as recommended · taken alone — recorded per decision, never per run: it is the distinction an unattended run exists to preserve. `Overturn` is an edit or a command. `Hardens when` names the event after which reversal stops being cheap. A ruling with no reversal path is a constraint, not a decision — it moves to § 12.
|
|
166
|
+
- **§ 5–7.** One home per fact: a red appears in § 5 even when a decision caused it, and the decision cites the row. `Mine?` is proved by the command or stash in `Proof`; `mine` is the default when no proof is offered. § 6 leads with behaviour, not plan slugs. § 7 exists so an owner scanning the repository does not mistake somebody else's branch for the run's debris.
|
|
167
|
+
- **§ 8 Proof.** **An unproven claim is an empty cell, never a sentence** — prose has no empty cell to scan for. `Independent?` reads `no` whenever one agent authored both the code and its pin, or found, fixed and pinned the same defect, and names who. Ledger counts are parsed from the plan, never quoted from an agent's summary, so `blocked` cannot hide inside "discharged". Every `G-n` names the command that would close it.
|
|
168
|
+
- **§ 9 State.** Present tense; a claim that cannot be re-proved by its `Re-prove` command does not belong here — it moves to § 15 as a dated event. Volatile things (`/tmp`, pid files, ports, tokens, browser connections) declare a lifetime and the command that makes them durable.
|
|
169
|
+
- **§ 10–12.** A loop is a runnable command or a named question, never a noun phrase and never "investigate"; one needing a person's judgment states the question and the default in force. A discovery is a present-tense fact with a guard — "Workers Builds does not fire on a `dev` merge", not "we found that it didn't"; `none — {what would hold it}` is an honest guard that feeds the backlog. Debt names where it now lives, so this file can be deleted without losing it.
|
|
170
|
+
- **§ 13–14.** Every uninstrumented number reads `unmeasured — {what would have measured it}`; a blank reports a cheaper run than the one that happened. **State whether the run's own corpus is version-controlled** — an untracked corpus is one `rm -rf` from being three PR descriptions, and archiving it is a § 1 row.
|
|
171
|
+
- **Ids are stable and run-global** — `D-`, `G-`, `L-`, `X-`, `T-` — so a PR comment or a successor cites a row instead of re-describing it. A withdrawn row keeps its id and states what disproved it.
|
|
172
|
+
- **Evidence is an address that outlives the run** — `path:line`, a 7-char sha, a PR number, a URL, or a command. A branch name is not a pointer; a `/tmp` log is not evidence — copy it into the record folder first.
|
|
173
|
+
- **Blanket claims are banned.** "All suites green", "every ledger discharged", "nothing was deployed" carry a count and the sha they are true of, or they become a `G-n` row.
|
|
174
|
+
- **The last act before showing the file is a contradiction pass**: the scoreboard against § 2, § 6 against § 1, every count against its source, every `{…}` resolved. An unresolved placeholder in an action cell is a defect of the same class as a broken command.
|
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
# Operations Procedure (docs/operations/{procedure}.md)
|
|
2
2
|
|
|
3
|
-
Truth document. Use for: any **recurring** procedure —
|
|
3
|
+
Truth document. Use for: any **recurring** procedure — development, deployment, maintenance. The one-time first run (prerequisites, install, env files, first commands, the stack) is not one of these: it has its own template and a fixed name, `templates/setup.md` → `docs/operations/setup.md`, one per repo. A procedure is consulted mid-task, not read: exact commands, copy-paste runnable, no narrative. Updated in place whenever the workflow changes.
|
|
4
4
|
|
|
5
5
|
A **one-shot** procedure (a migration, an upgrade, an incident response executed once) is not an operations doc — it is a **Migration Runbook** (record, below). The test: will someone run this again next month? Yes → operations. No → runbook.
|
|
6
6
|
|