docs: VISION for v1.0 + clarify docs/ vs agent/ vs .claude
All checks were successful
Check / eval (push) Successful in 3m7s

Add docs/VISION.md (product themes, v1.0 bar, agent slice hints) and
README maps under docs/ and agent/. Point ROADMAP, BACKLOG, LOOP,
CLAUDE, HARDWARE, and the root README at the split: VISION = intent,
BACKLOG = executable queue, ROADMAP = design history, .claude = harness
only. Mark v1.0 track in BACKLOG PROPOSED for human triage.
This commit is contained in:
Bernardo Magri
2026-07-09 09:33:51 +01:00
parent caaac88da9
commit 02d7baeb7c
10 changed files with 340 additions and 52 deletions

View File

@@ -4,29 +4,38 @@ Nomarchy is a NixOS-based distro: rock-stable, fully reproducible, themed
from one JSON, configured through a menu that writes into the user's own
flake checkout. Read the README for the architecture.
## Where things live (read this first)
| Path | Role |
|------|------|
| **`agent/`** | Loop state — **only executable queue is `BACKLOG.md`** |
| **`docs/VISION.md`** | Product themes toward **v1.0** (not a queue) |
| **`docs/ROADMAP.md`** | Design history + shipped log |
| **`docs/README.md`** | Full documentation map |
| **`agent/README.md`** | Map of loop files |
| **`.claude/`** | Claude Code only (permissions + subagents) — not the backlog |
## If you're here to work autonomously (the loop)
Follow **`agent/LOOP.md`** — it defines one iteration: orient
(GOALS/BACKLOG/JOURNAL/MEMORY), take the top actionable BACKLOG item,
verify up the V0V3 ladder, commit+push on `main`, record. All loop state
is git-tracked in `agent/`.
Follow **`agent/LOOP.md`** — one iteration: orient → pick one BACKLOG
item → work → verify → commit+push on `main` → record. All loop state is
git-tracked in `agent/`.
## Rules that apply to every session, loop or not
- **Honesty rule** (docs/TESTING.md): for visual/interactive changes,
evaluation is not rendering — state exactly what you verified and at
which tier. Cheap check first, always: `nix flake check --no-build`.
- **Honesty rule** (`docs/TESTING.md`): for visual/interactive changes,
evaluation is not rendering — state the tier you reached. Cheap first:
`nix flake check --no-build`.
- **Conventions** (`agent/CONVENTIONS.md`): in-flake state, menu
placement, Waybar parity with the summer whole-swaps, toggle-vs-package
discipline, commented template examples for opt-ins.
- **Git:** direct commits on `main`, pushed; `v1` is the human-only
release pointer — never touch it. Never run `nix flake update` unless
the task is a lock bump. No formatter — match the aligned
hand-formatting.
- Machine-specifics live in `hosts/`, the distro in `modules/`, data in
`themes/`, code in `pkgs/`, maintainer tools in `tools/`.
placement, Waybar parity with whole-swaps, toggle-vs-package discipline,
template as SoT for opt-in comments (`templates/downstream`).
- **Git:** direct commits on `main`, pushed; **`v1` is human-only** —
never touch it. Never `nix flake update` unless the task is a lock bump.
No formatter — match aligned hand-formatting.
- Layout: `hosts/` machine · `modules/` distro · `themes/` data ·
`pkgs/` code · `tools/` maintainer · `agent/` loop · `docs/` human docs.
## Delegation
The higher your tier, the more you delegate. Push the work down, keep your own context for judgment. Brief every child: the context, the why, what done looks like. It starts blank and inherits nothing.
Push mechanical work down; keep judgment. Brief every child cold.
| Model | Best for | Delegate? | Effort |
|---|---|---|---|
@@ -39,4 +48,5 @@ Fable goes xhigh only for the hardest calls. Skip high.
## Escalation
The parent doesn't have to be the top model. An Opus parent spawns a Fable child for the one hard call. The child answers and returns. Work above your tier? Return it, don't burn tokens on it.
An Opus parent can spawn a Fable child for one hard call. Work above your
tier? Return it — don't burn tokens.