Skip to content
Open
Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
142 commits
Select commit Hold shift + click to select a range
fa0a01b
Configure Matt Pocock engineering skills (local markdown, single-cont…
Ignition Jun 9, 2026
2ad7538
Track .claude skills directory
Ignition Jun 9, 2026
663fc37
Bridge AGENTS.md into context and localize triage example for local-m…
Ignition Jun 9, 2026
b4716ae
Plan Rust rewrite of mgconsole: CONTEXT, ADRs, PRD, 32 issues
Ignition Jun 9, 2026
b627b50
01 Bolt fidelity spike: GO — pure-Rust Bolt confirmed
Ignition Jun 9, 2026
f39e341
02 Tracer bullet: core+cli workspace, Session, QueryResult
Ignition Jun 9, 2026
7f0561c
03 Tabular rendering seam + golden harness (scalars/strings)
Ignition Jun 9, 2026
917be79
04 Render lists + maps (tabular) + goldens
Ignition Jun 10, 2026
52ebf13
05 Render nodes + relationships + paths (tabular) + goldens
Ignition Jun 10, 2026
6577bb9
06 Render temporal values (tabular) + goldens
Ignition Jun 10, 2026
d89836d
07 Render spatial points + enums (tabular) + goldens
Ignition Jun 10, 2026
ef151e4
08 Tabular layout: column sizing, fit-to-screen, row-cap
Ignition Jun 10, 2026
045fa20
15 Line/query parsing: multiline, multi-query, carryover
Ignition Jun 10, 2026
7afd953
27 Clause scanner (vertices-first detection)
Ignition Jun 10, 2026
6368079
21 Streaming record API with bounded memory
Ignition Jun 10, 2026
d5d050c
22-24 Streaming output writers: csv, jsonl, cypherl
Ignition Jun 10, 2026
d6c5887
Grilling outcomes: session guard, worker-pull import, dev hygiene
Ignition Jun 10, 2026
8933930
Track shared-container harness refactor in issue 12
Ignition Jun 10, 2026
f6540a6
09 CLI flag surface: clap flags, jsonl, validation + pure tests
Ignition Jun 10, 2026
f9d42e9
10 Auth: basic-scheme connect, Auth error, hidden password prompt
Ignition Jun 10, 2026
5cf460b
11 TLS via rustls (ring): MaybeTlsStream transport, ConnectOptions
Ignition Jun 10, 2026
1d110ab
12 Query parameters + shared-container test harness
Ignition Jun 10, 2026
c220349
13 Summary: notifications, update stats, verbose execution info
Ignition Jun 10, 2026
63ea4dc
14 Error taxonomy, RESET recovery, reconnect, one-live-result guard
Ignition Jun 10, 2026
59a458c
16 Session reconnect observer hook (surfaces attempts to a Frontend)
Ignition Jun 10, 2026
e3c3763
16 REPL pure seams: completeness, meta-commands, result summary
Ignition Jun 10, 2026
601b5a7
16 REPL execute loop over LineSource/QueryRunner seams + fakes
Ignition Jun 10, 2026
8b436f6
16 REPL loop wired: rustyline + piped sources, SessionRunner, fit-to-…
Ignition Jun 10, 2026
584138b
17 History path resolution, dir prep, and FileHistory persistence wra…
Ignition Jun 10, 2026
268ef98
17 Wire persistent history into RustylineSource + main (env override,…
Ignition Jun 10, 2026
e45ace6
18 Cypher syntax module: static completion (extensible) + highlightin…
Ignition Jun 10, 2026
b2ec347
18 Wire completion + highlighting into rustyline helper; --term-color…
Ignition Jun 10, 2026
a63ffe5
19 :help and :docs REPL commands (carried from mgconsole usage text)
Ignition Jun 10, 2026
4c39bfa
20 :param/:params REPL commands: server-side eval, store, bind to que…
Ignition Jun 10, 2026
1d901fa
25 Serial import: core engine, non-TTY pipe path, format output, exit…
Ignition Jun 10, 2026
ab17de4
26 DUMP DATABASE -> cypherl export/import round-trip (integration); q…
Ignition Jun 10, 2026
5da9d78
28 Parser import mode: clause-scan report, no DB execution, --parser-…
Ignition Jun 10, 2026
f2fb698
29 Worker Sessions: establish N connections, configurable count, inde…
Ignition Jun 10, 2026
39665d7
30 Batched-parallel executor: worker-pull over shared queue, batch/wo…
Ignition Jun 10, 2026
89945b6
31 Vertices-first ordering: two-phase barrier (nodes then edges) via …
Ignition Jun 10, 2026
459000f
32 Retry-with-backoff on serialization conflicts (specific leaf code,…
Ignition Jun 10, 2026
5aa6a8e
33 Enable clippy pedantic (with documented allows); fix flagged idioms
Ignition Jun 10, 2026
4697846
Architecture deepening: grilled PRD + 4 AFK issues
Ignition Jun 10, 2026
c4af671
34 Adopt rustfmt: format the workspace to stable defaults
Ignition Jun 10, 2026
27326f0
35 Typed-key Bolt metadata accessor (Meta + Key<T>)
Ignition Jun 10, 2026
3d533b7
36 Endpoint cohesion type for host + port
Ignition Jun 10, 2026
3927b1b
37 Error wrap constructors (Error::connection / Error::protocol)
Ignition Jun 10, 2026
91947a3
38 Header type at the format seam
Ignition Jun 10, 2026
b8e28f1
Mark architecture-deepening issues 01–04 done in the tracker
Ignition Jun 10, 2026
8f893c6
Cypher highlighting: PRD, issues, ADRs 0008/0009, Token glossary
Ignition Jun 10, 2026
2ee62b8
01 Core Cypher lexer (typed, byte-spanned, total)
Ignition Jun 10, 2026
ed5ac9c
02 Highlighter cutover: keyword+function on the Core lexer
Ignition Jun 10, 2026
c4b2a9f
03 Literal & comment palette: string green, number magenta, comment grey
Ignition Jun 10, 2026
78aa542
04 Query-parameter colour: $name blue
Ignition Jun 10, 2026
596015c
05 --color flag, interactive colour on by default
Ignition Jun 10, 2026
e185afc
06 Consolidate parse.rs onto the Core lexer
Ignition Jun 10, 2026
f75eb3a
07 Consolidate clause.rs onto the Core lexer
Ignition Jun 10, 2026
9bb4f52
Mark rust-console issues 09–32 done in the tracker
Ignition Jun 10, 2026
4f64e4e
TUI workbench: ADR 0010, Schema glossary term, PRD + 18 issues
Ignition Jun 10, 2026
708ad24
tui-workbench 04: Frontend-neutral HighlightCategory
Ignition Jun 10, 2026
acd9547
tui-workbench 01: approved shell/reducer/lifecycle design
Ignition Jun 10, 2026
309dc94
tui-workbench 01: frontend selection + workbench shell foundation
Ignition Jun 10, 2026
662917a
tui-workbench 02: non-blocking query execution spine
Ignition Jun 10, 2026
502c5fc
tui-workbench 03: streaming results table widget
Ignition Jun 10, 2026
419260e
tui-workbench 05: editor input syntax highlighting
Ignition Jun 10, 2026
84f06cc
tui-workbench 06: newline chords via keyboard-enhancement protocol
Ignition Jun 10, 2026
fe56ec8
tui-workbench 07: cancellation, partial rows, running indicator
Ignition Jun 10, 2026
136dcf7
tui-workbench 08: cell-expand detail overlay
Ignition Jun 10, 2026
343ab14
tui-workbench 09: export the on-screen result
Ignition Jun 10, 2026
faff08a
tui-workbench 10: result history stack
Ignition Jun 10, 2026
ffdba0f
tui-workbench 11: static completion popup
Ignition Jun 10, 2026
e477b5f
tui-workbench 12: live schema completion source
Ignition Jun 10, 2026
5684a2c
tui-workbench 13: schema sidebar drawer
Ignition Jun 10, 2026
cfeb2f1
tui-workbench 14: EXPLAIN/PROFILE plan tree
Ignition Jun 10, 2026
427b367
tui-workbench 15: PROFILE plan annotations
Ignition Jun 10, 2026
2c3d209
tui-workbench 16: workbench query parameters
Ignition Jun 10, 2026
eefcf61
tui-workbench 17: persisted history recall
Ignition Jun 10, 2026
f93d78c
tui-workbench 18: surface notifications, stats, and execution info
Ignition Jun 10, 2026
4fdc078
Console ergonomics: grilled PRD + 18 AFK issues, ADRs 0011/0012, glos…
Ignition Jun 10, 2026
3eb4c1f
console-ergonomics 01a: Core vertical display mode + auto layout deci…
Ignition Jun 10, 2026
b871d90
console-ergonomics 01: :set Setting spine across REPL + Workbench
Ignition Jun 10, 2026
960fd4c
console-ergonomics 02: ~/.mgconsole state dir + config.toml [settings…
Ignition Jun 10, 2026
df123f1
docs(adr): name reclaim (0013) and non-interactive stdio conventions …
Ignition Jun 10, 2026
5069ca1
console-ergonomics 03: connection profiles + --profile + active-profi…
Ignition Jun 10, 2026
0762152
docs(issues): non-interactive stdio slices 19-21 (ADR 0014)
Ignition Jun 10, 2026
f39aa33
console-ergonomics 04: read-only mode (Bolt READ access mode)
Ignition Jun 10, 2026
caadc43
console-ergonomics 05: explicit transactions (Session transaction state)
Ignition Jun 10, 2026
a0e1697
console-ergonomics 06: state-dependent reconnect inside a transaction
Ignition Jun 10, 2026
1b142e9
console-ergonomics 07: :connect = Session swap
Ignition Jun 10, 2026
7b3dbb4
console-ergonomics 08: :use = active-Database switch (multi-tenancy)
Ignition Jun 10, 2026
5e6fa1b
console-ergonomics 09: :sysinfo server status
Ignition Jun 10, 2026
7b3e780
console-ergonomics 10: :source <file> run a file in-session
Ignition Jun 10, 2026
99fc5ba
console-ergonomics 11: :watch re-run on a timer
Ignition Jun 10, 2026
dbef47f
console-ergonomics 12: :o one-shot output redirection + shared format…
Ignition Jun 10, 2026
eba9c03
console-ergonomics 13: named queries (:save/:saved/:load/:forget)
Ignition Jun 10, 2026
6d060ae
console-ergonomics 14: theme + keybinding config (Workbench)
Ignition Jun 10, 2026
3b95a10
console-ergonomics 15: auto-format Cypher (Workbench gesture)
Ignition Jun 10, 2026
bb38ad2
console-ergonomics 16: in-result search/filter (Workbench)
Ignition Jun 10, 2026
790e273
console-ergonomics 17: mouse support (Workbench)
Ignition Jun 10, 2026
aef7722
console-ergonomics 18: multiple buffers/tabs (Workbench)
Ignition Jun 10, 2026
936e5c6
console-ergonomics 19: TTY-aware default output format + stream disci…
Ignition Jun 10, 2026
21522e1
console-ergonomics 20: run [FILES…] / run - explicit batch subcommand
Ignition Jun 10, 2026
14e47ae
console-ergonomics 21: -c "QUERY" one-shot
Ignition Jun 10, 2026
66663fa
workbench: :help opens a keybinding + command overlay
Ignition Jun 10, 2026
16f6ee2
workbench: render PROFILE plans as a tree-in-a-table
Ignition Jun 10, 2026
d64fbe9
workbench: reconstruct the real plan tree + tighten the metrics columns
Ignition Jun 10, 2026
9d43085
workbench-ergonomics 01: content-aware result columns
Ignition Jun 10, 2026
600802c
workbench-ergonomics 02: free Ctrl+W, :close, Ctrl+PageUp/Down nav
Ignition Jun 10, 2026
4bd8dce
workbench-ergonomics 03: a live query belongs to its origin Buffer
Ignition Jun 10, 2026
2ded7ba
workbench-ergonomics 04: copy a Value out via OSC 52 yank + :set mouse
Ignition Jun 10, 2026
aa7f70d
workbench-ergonomics 05: correlated Result history — failures are ent…
Ignition Jun 10, 2026
eff0c0e
workbench-ergonomics 06: bound the Result history
Ignition Jun 10, 2026
894ed6d
workbench-ergonomics 07: auto-titled tabs + windowed tab bar
Ignition Jun 11, 2026
73a30f3
workbench-ergonomics 08: extended theme (UI slots) + light built-in
Ignition Jun 11, 2026
d0b038c
workbench-ergonomics 09: undoable buffer replacement + Ctrl+Z/Ctrl+Y
Ignition Jun 11, 2026
704d3d7
workbench-ergonomics 10: ? opens help; hint + help reflect live keys
Ignition Jun 11, 2026
3d8838e
workbench-ergonomics 11: overlay scroll indicators (help + cell-detail)
Ignition Jun 11, 2026
de1dc97
workbench: resolve :close model + Ctrl+Y collision (grilling; ADR 0016)
Ignition Jun 11, 2026
6b7927a
workbench-ergonomics-2: PRD, issues, ADRs 0017/0018, CONTEXT vocab
Ignition Jun 11, 2026
544385f
workbench-ergonomics-2 01: modal command line; editor is Cypher-only
Ignition Jun 11, 2026
4bfc0fe
workbench-ergonomics-2 02: command-line completion + recall
Ignition Jun 11, 2026
e419598
workbench-ergonomics-2 03: Tab = completion-only; Shift+Tab = focus-s…
Ignition Jun 11, 2026
42b33cd
workbench-ergonomics-2 04: transaction episode model + correlated his…
Ignition Jun 11, 2026
cb9c42f
workbench-ergonomics-2 05: bolder transaction status indicator
Ignition Jun 11, 2026
b77d47b
workbench-ergonomics-2 06: clipboard helper process + OSC 52 fallback
Ignition Jun 11, 2026
e7925d4
workbench/repl: canonicalize the shared Meta-command policy messages
Ignition Jun 11, 2026
396b402
scratch: record architecture-review findings
Ignition Jun 11, 2026
cd0f49f
console-ergonomics 22: first-run example config scaffold (issue + ADR…
Ignition Jun 11, 2026
9c2bc86
workbench: fold the in-flight query into the RunState::Running variant
Ignition Jun 11, 2026
d04e66d
workbench: one Modal sum type for the six input-capturing overlays
Ignition Jun 11, 2026
ab2326d
scratch: record architecture-review round 2 findings
Ignition Jun 11, 2026
5dd18e3
frontend-switch: ADR 0019 + glossary + issues for runtime REPL<->Work…
Ignition Jun 11, 2026
98e62c8
console-ergonomics 22: scaffold a commented example config.toml on fi…
Ignition Jun 11, 2026
0594dc6
console-ergonomics 23: back named queries with a directory of .cypher…
Ignition Jun 11, 2026
8c69a95
console-ergonomics 24: MGCONSOLE_PASSWORD env var for non-interactive…
Ignition Jun 11, 2026
7d2a70b
frontend-switch 01: :repl down-switch from the Workbench over a prese…
Ignition Jun 11, 2026
5eb7661
frontend-switch 01: mark issue done
Ignition Jun 11, 2026
339f366
frontend-switch 02: :workbench up-switch from the REPL, capability-gated
Ignition Jun 11, 2026
a26cc75
frontend-switch 03: carry the active query editor text across a switch
Ignition Jun 11, 2026
3c49f19
frontend-switch 04: triage to ready-for-agent
Ignition Jun 11, 2026
e149e17
frontend-switch 04: non-destructive Workbench view-parking across a s…
Ignition Jun 11, 2026
8893495
Add 'experiment/rust/' from commit 'e149e17502d685069eb782a019ebfd00c…
Ignition Jun 11, 2026
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
10 changes: 10 additions & 0 deletions experiment/rust/.cargo/config.toml
Original file line number Diff line number Diff line change
@@ -0,0 +1,10 @@
# Local development shortcuts (no CI; local testing only).
#
# Common commands:
# cargo test --workspace run all tests (the integration tests need a
# Docker daemon; testcontainers starts Memgraph)
# UPDATE_GOLDEN=1 cargo test regenerate rendering golden files
# cargo lint clippy across the workspace (alias below)
# cargo fmt format
[alias]
lint = "clippy --workspace --all-targets"
117 changes: 117 additions & 0 deletions experiment/rust/.claude/skills/diagnose/SKILL.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,117 @@
---
name: diagnose
description: Disciplined diagnosis loop for hard bugs and performance regressions. Reproduce → minimise → hypothesise → instrument → fix → regression-test. Use when user says "diagnose this" / "debug this", reports a bug, says something is broken/throwing/failing, or describes a performance regression.
---

# Diagnose

A discipline for hard bugs. Skip phases only when explicitly justified.

When exploring the codebase, use the project's domain glossary to get a clear mental model of the relevant modules, and check ADRs in the area you're touching.

## Phase 1 — Build a feedback loop

**This is the skill.** Everything else is mechanical. If you have a fast, deterministic, agent-runnable pass/fail signal for the bug, you will find the cause — bisection, hypothesis-testing, and instrumentation all just consume that signal. If you don't have one, no amount of staring at code will save you.

Spend disproportionate effort here. **Be aggressive. Be creative. Refuse to give up.**

### Ways to construct one — try them in roughly this order

1. **Failing test** at whatever seam reaches the bug — unit, integration, e2e.
2. **Curl / HTTP script** against a running dev server.
3. **CLI invocation** with a fixture input, diffing stdout against a known-good snapshot.
4. **Headless browser script** (Playwright / Puppeteer) — drives the UI, asserts on DOM/console/network.
5. **Replay a captured trace.** Save a real network request / payload / event log to disk; replay it through the code path in isolation.
6. **Throwaway harness.** Spin up a minimal subset of the system (one service, mocked deps) that exercises the bug code path with a single function call.
7. **Property / fuzz loop.** If the bug is "sometimes wrong output", run 1000 random inputs and look for the failure mode.
8. **Bisection harness.** If the bug appeared between two known states (commit, dataset, version), automate "boot at state X, check, repeat" so you can `git bisect run` it.
9. **Differential loop.** Run the same input through old-version vs new-version (or two configs) and diff outputs.
10. **HITL bash script.** Last resort. If a human must click, drive _them_ with `scripts/hitl-loop.template.sh` so the loop is still structured. Captured output feeds back to you.

Build the right feedback loop, and the bug is 90% fixed.

### Iterate on the loop itself

Treat the loop as a product. Once you have _a_ loop, ask:

- Can I make it faster? (Cache setup, skip unrelated init, narrow the test scope.)
- Can I make the signal sharper? (Assert on the specific symptom, not "didn't crash".)
- Can I make it more deterministic? (Pin time, seed RNG, isolate filesystem, freeze network.)

A 30-second flaky loop is barely better than no loop. A 2-second deterministic loop is a debugging superpower.

### Non-deterministic bugs

The goal is not a clean repro but a **higher reproduction rate**. Loop the trigger 100×, parallelise, add stress, narrow timing windows, inject sleeps. A 50%-flake bug is debuggable; 1% is not — keep raising the rate until it's debuggable.

### When you genuinely cannot build a loop

Stop and say so explicitly. List what you tried. Ask the user for: (a) access to whatever environment reproduces it, (b) a captured artifact (HAR file, log dump, core dump, screen recording with timestamps), or (c) permission to add temporary production instrumentation. Do **not** proceed to hypothesise without a loop.

Do not proceed to Phase 2 until you have a loop you believe in.

## Phase 2 — Reproduce

Run the loop. Watch the bug appear.

Confirm:

- [ ] The loop produces the failure mode the **user** described — not a different failure that happens to be nearby. Wrong bug = wrong fix.
- [ ] The failure is reproducible across multiple runs (or, for non-deterministic bugs, reproducible at a high enough rate to debug against).
- [ ] You have captured the exact symptom (error message, wrong output, slow timing) so later phases can verify the fix actually addresses it.

Do not proceed until you reproduce the bug.

## Phase 3 — Hypothesise

Generate **3–5 ranked hypotheses** before testing any of them. Single-hypothesis generation anchors on the first plausible idea.

Each hypothesis must be **falsifiable**: state the prediction it makes.

> Format: "If <X> is the cause, then <changing Y> will make the bug disappear / <changing Z> will make it worse."

If you cannot state the prediction, the hypothesis is a vibe — discard or sharpen it.

**Show the ranked list to the user before testing.** They often have domain knowledge that re-ranks instantly ("we just deployed a change to #3"), or know hypotheses they've already ruled out. Cheap checkpoint, big time saver. Don't block on it — proceed with your ranking if the user is AFK.

## Phase 4 — Instrument

Each probe must map to a specific prediction from Phase 3. **Change one variable at a time.**

Tool preference:

1. **Debugger / REPL inspection** if the env supports it. One breakpoint beats ten logs.
2. **Targeted logs** at the boundaries that distinguish hypotheses.
3. Never "log everything and grep".

**Tag every debug log** with a unique prefix, e.g. `[DEBUG-a4f2]`. Cleanup at the end becomes a single grep. Untagged logs survive; tagged logs die.

**Perf branch.** For performance regressions, logs are usually wrong. Instead: establish a baseline measurement (timing harness, `performance.now()`, profiler, query plan), then bisect. Measure first, fix second.

## Phase 5 — Fix + regression test

Write the regression test **before the fix** — but only if there is a **correct seam** for it.

A correct seam is one where the test exercises the **real bug pattern** as it occurs at the call site. If the only available seam is too shallow (single-caller test when the bug needs multiple callers, unit test that can't replicate the chain that triggered the bug), a regression test there gives false confidence.

**If no correct seam exists, that itself is the finding.** Note it. The codebase architecture is preventing the bug from being locked down. Flag this for the next phase.

If a correct seam exists:

1. Turn the minimised repro into a failing test at that seam.
2. Watch it fail.
3. Apply the fix.
4. Watch it pass.
5. Re-run the Phase 1 feedback loop against the original (un-minimised) scenario.

## Phase 6 — Cleanup + post-mortem

Required before declaring done:

- [ ] Original repro no longer reproduces (re-run the Phase 1 loop)
- [ ] Regression test passes (or absence of seam is documented)
- [ ] All `[DEBUG-...]` instrumentation removed (`grep` the prefix)
- [ ] Throwaway prototypes deleted (or moved to a clearly-marked debug location)
- [ ] The hypothesis that turned out correct is stated in the commit / PR message — so the next debugger learns

**Then ask: what would have prevented this bug?** If the answer involves architectural change (no good test seam, tangled callers, hidden coupling) hand off to the `/improve-codebase-architecture` skill with the specifics. Make the recommendation **after** the fix is in, not before — you have more information now than when you started.
Original file line number Diff line number Diff line change
@@ -0,0 +1,41 @@
#!/usr/bin/env bash
# Human-in-the-loop reproduction loop.
# Copy this file, edit the steps below, and run it.
# The agent runs the script; the user follows prompts in their terminal.
#
# Usage:
# bash hitl-loop.template.sh
#
# Two helpers:
# step "<instruction>" → show instruction, wait for Enter
# capture VAR "<question>" → show question, read response into VAR
#
# At the end, captured values are printed as KEY=VALUE for the agent to parse.

set -euo pipefail

step() {
printf '\n>>> %s\n' "$1"
read -r -p " [Enter when done] " _
}

capture() {
local var="$1" question="$2" answer
printf '\n>>> %s\n' "$question"
read -r -p " > " answer
printf -v "$var" '%s' "$answer"
}

# --- edit below ---------------------------------------------------------

step "Open the app at http://localhost:3000 and sign in."

capture ERRORED "Click the 'Export' button. Did it throw an error? (y/n)"

capture ERROR_MSG "Paste the error message (or 'none'):"

# --- edit above ---------------------------------------------------------

printf '\n--- Captured ---\n'
printf 'ERRORED=%s\n' "$ERRORED"
printf 'ERROR_MSG=%s\n' "$ERROR_MSG"
47 changes: 47 additions & 0 deletions experiment/rust/.claude/skills/grill-with-docs/ADR-FORMAT.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,47 @@
# ADR Format

ADRs live in `docs/adr/` and use sequential numbering: `0001-slug.md`, `0002-slug.md`, etc.

Create the `docs/adr/` directory lazily — only when the first ADR is needed.

## Template

```md
# {Short title of the decision}

{1-3 sentences: what's the context, what did we decide, and why.}
```

That's it. An ADR can be a single paragraph. The value is in recording *that* a decision was made and *why* — not in filling out sections.

## Optional sections

Only include these when they add genuine value. Most ADRs won't need them.

- **Status** frontmatter (`proposed | accepted | deprecated | superseded by ADR-NNNN`) — useful when decisions are revisited
- **Considered Options** — only when the rejected alternatives are worth remembering
- **Consequences** — only when non-obvious downstream effects need to be called out

## Numbering

Scan `docs/adr/` for the highest existing number and increment by one.

## When to offer an ADR

All three of these must be true:

1. **Hard to reverse** — the cost of changing your mind later is meaningful
2. **Surprising without context** — a future reader will look at the code and wonder "why on earth did they do it this way?"
3. **The result of a real trade-off** — there were genuine alternatives and you picked one for specific reasons

If a decision is easy to reverse, skip it — you'll just reverse it. If it's not surprising, nobody will wonder why. If there was no real alternative, there's nothing to record beyond "we did the obvious thing."

### What qualifies

- **Architectural shape.** "We're using a monorepo." "The write model is event-sourced, the read model is projected into Postgres."
- **Integration patterns between contexts.** "Ordering and Billing communicate via domain events, not synchronous HTTP."
- **Technology choices that carry lock-in.** Database, message bus, auth provider, deployment target. Not every library — just the ones that would take a quarter to swap out.
- **Boundary and scope decisions.** "Customer data is owned by the Customer context; other contexts reference it by ID only." The explicit no-s are as valuable as the yes-s.
- **Deliberate deviations from the obvious path.** "We're using manual SQL instead of an ORM because X." Anything where a reasonable reader would assume the opposite. These stop the next engineer from "fixing" something that was deliberate.
- **Constraints not visible in the code.** "We can't use AWS because of compliance requirements." "Response times must be under 200ms because of the partner API contract."
- **Rejected alternatives when the rejection is non-obvious.** If you considered GraphQL and picked REST for subtle reasons, record it — otherwise someone will suggest GraphQL again in six months.
60 changes: 60 additions & 0 deletions experiment/rust/.claude/skills/grill-with-docs/CONTEXT-FORMAT.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,60 @@
# CONTEXT.md Format

## Structure

```md
# {Context Name}

{One or two sentence description of what this context is and why it exists.}

## Language

**Order**:
{A one or two sentence description of the term}
_Avoid_: Purchase, transaction

**Invoice**:
A request for payment sent to a customer after delivery.
_Avoid_: Bill, payment request

**Customer**:
A person or organization that places orders.
_Avoid_: Client, buyer, account
```

## Rules

- **Be opinionated.** When multiple words exist for the same concept, pick the best one and list the others under `_Avoid_`.
- **Keep definitions tight.** One or two sentences max. Define what it IS, not what it does.
- **Only include terms specific to this project's context.** General programming concepts (timeouts, error types, utility patterns) don't belong even if the project uses them extensively. Before adding a term, ask: is this a concept unique to this context, or a general programming concept? Only the former belongs.
- **Group terms under subheadings** when natural clusters emerge. If all terms belong to a single cohesive area, a flat list is fine.

## Single vs multi-context repos

**Single context (most repos):** One `CONTEXT.md` at the repo root.

**Multiple contexts:** A `CONTEXT-MAP.md` at the repo root lists the contexts, where they live, and how they relate to each other:

```md
# Context Map

## Contexts

- [Ordering](./src/ordering/CONTEXT.md) — receives and tracks customer orders
- [Billing](./src/billing/CONTEXT.md) — generates invoices and processes payments
- [Fulfillment](./src/fulfillment/CONTEXT.md) — manages warehouse picking and shipping

## Relationships

- **Ordering → Fulfillment**: Ordering emits `OrderPlaced` events; Fulfillment consumes them to start picking
- **Fulfillment → Billing**: Fulfillment emits `ShipmentDispatched` events; Billing consumes them to generate invoices
- **Ordering ↔ Billing**: Shared types for `CustomerId` and `Money`
```

The skill infers which structure applies:

- If `CONTEXT-MAP.md` exists, read it to find contexts
- If only a root `CONTEXT.md` exists, single context
- If neither exists, create a root `CONTEXT.md` lazily when the first term is resolved

When multiple contexts exist, infer which one the current topic relates to. If unclear, ask.
88 changes: 88 additions & 0 deletions experiment/rust/.claude/skills/grill-with-docs/SKILL.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,88 @@
---
name: grill-with-docs
description: Grilling session that challenges your plan against the existing domain model, sharpens terminology, and updates documentation (CONTEXT.md, ADRs) inline as decisions crystallise. Use when user wants to stress-test a plan against their project's language and documented decisions.
---

<what-to-do>

Interview me relentlessly about every aspect of this plan until we reach a shared understanding. Walk down each branch of the design tree, resolving dependencies between decisions one-by-one. For each question, provide your recommended answer.

Ask the questions one at a time, waiting for feedback on each question before continuing.

If a question can be answered by exploring the codebase, explore the codebase instead.

</what-to-do>

<supporting-info>

## Domain awareness

During codebase exploration, also look for existing documentation:

### File structure

Most repos have a single context:

```
/
├── CONTEXT.md
├── docs/
│ └── adr/
│ ├── 0001-event-sourced-orders.md
│ └── 0002-postgres-for-write-model.md
└── src/
```

If a `CONTEXT-MAP.md` exists at the root, the repo has multiple contexts. The map points to where each one lives:

```
/
├── CONTEXT-MAP.md
├── docs/
│ └── adr/ ← system-wide decisions
├── src/
│ ├── ordering/
│ │ ├── CONTEXT.md
│ │ └── docs/adr/ ← context-specific decisions
│ └── billing/
│ ├── CONTEXT.md
│ └── docs/adr/
```

Create files lazily — only when you have something to write. If no `CONTEXT.md` exists, create one when the first term is resolved. If no `docs/adr/` exists, create it when the first ADR is needed.

## During the session

### Challenge against the glossary

When the user uses a term that conflicts with the existing language in `CONTEXT.md`, call it out immediately. "Your glossary defines 'cancellation' as X, but you seem to mean Y — which is it?"

### Sharpen fuzzy language

When the user uses vague or overloaded terms, propose a precise canonical term. "You're saying 'account' — do you mean the Customer or the User? Those are different things."

### Discuss concrete scenarios

When domain relationships are being discussed, stress-test them with specific scenarios. Invent scenarios that probe edge cases and force the user to be precise about the boundaries between concepts.

### Cross-reference with code

When the user states how something works, check whether the code agrees. If you find a contradiction, surface it: "Your code cancels entire Orders, but you just said partial cancellation is possible — which is right?"

### Update CONTEXT.md inline

When a term is resolved, update `CONTEXT.md` right there. Don't batch these up — capture them as they happen. Use the format in [CONTEXT-FORMAT.md](./CONTEXT-FORMAT.md).

`CONTEXT.md` should be totally devoid of implementation details. Do not treat `CONTEXT.md` as a spec, a scratch pad, or a repository for implementation decisions. It is a glossary and nothing else.

### Offer ADRs sparingly

Only offer to create an ADR when all three are true:

1. **Hard to reverse** — the cost of changing your mind later is meaningful
2. **Surprising without context** — a future reader will wonder "why did they do it this way?"
3. **The result of a real trade-off** — there were genuine alternatives and you picked one for specific reasons

If any of the three is missing, skip the ADR. Use the format in [ADR-FORMAT.md](./ADR-FORMAT.md).

</supporting-info>
Loading
Loading