docs: VISION for v1.0 + clarify docs/ vs agent/ vs .claude
All checks were successful
Check / eval (push) Successful in 3m7s
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:
31
README.md
31
README.md
@@ -74,13 +74,15 @@ Flat on purpose. Two module trees, one options file each, no hidden layers.
|
||||
│ ├── nomarchy-theme-sync/ # state writer + rebuild dispatcher (Python)
|
||||
│ └── nomarchy-install/ # live-ISO installer (gum + disko + mkFlake)
|
||||
├── templates/downstream/ # machine flake SoT (`flake init` + installer copy/patch)
|
||||
├── docs/TESTING.md # how to verify changes (incl. AI-agent rules)
|
||||
├── docs/HARDWARE.md # firmware, drivers, profiles, unsupported machines
|
||||
├── docs/OVERRIDES.md # how downstream users override defaults
|
||||
├── docs/RECOVERY.md # runbook: broken theme/desktop/boot → undo it
|
||||
├── docs/ROADMAP.md # design/decision records + shipped-fixes log
|
||||
├── agent/ # autonomous-agent loop: protocol (LOOP.md),
|
||||
│ # prioritized BACKLOG, journal, memory
|
||||
├── docs/ # human docs — map: docs/README.md
|
||||
│ ├── VISION.md # product themes toward v1.0 (not a queue)
|
||||
│ ├── ROADMAP.md # design/decision records + shipped log
|
||||
│ ├── HARDWARE.md # firmware, profiles, drivers
|
||||
│ ├── TESTING.md · RECOVERY.md · OVERRIDES.md · MIGRATION.md
|
||||
├── agent/ # agent loop state — map: agent/README.md
|
||||
│ # BACKLOG (executable queue), LOOP, GOALS, …
|
||||
├── CLAUDE.md # agent harness entry (points at agent/ + docs/)
|
||||
├── .claude/ # Claude Code only: permissions + subagents
|
||||
└── tools/ # maintainer-only
|
||||
├── import-palettes.py # converts old-distro themes → JSON + assets
|
||||
├── test-live-iso.sh # build the ISO + boot it in QEMU
|
||||
@@ -442,9 +444,12 @@ reload # exec zsh (reload the shell)
|
||||
|
||||
## Roadmap & known issues
|
||||
|
||||
The prioritized queue of what's next lives in
|
||||
**[agent/BACKLOG.md](agent/BACKLOG.md)**; the detailed design/decision
|
||||
records and the log of shipped fixes stay in
|
||||
**[docs/ROADMAP.md](docs/ROADMAP.md)**. Development runs on an
|
||||
agent-driven loop — see **[agent/LOOP.md](agent/LOOP.md)**. Kept out of
|
||||
the README so this stays a focused entry point.
|
||||
| Doc | Role |
|
||||
|-----|------|
|
||||
| **[agent/BACKLOG.md](agent/BACKLOG.md)** | What to do next (agent queue) |
|
||||
| **[docs/VISION.md](docs/VISION.md)** | Product themes toward **v1.0** |
|
||||
| **[docs/ROADMAP.md](docs/ROADMAP.md)** | Design history + shipped log |
|
||||
| **[docs/README.md](docs/README.md)** · **[agent/README.md](agent/README.md)** | Maps |
|
||||
| **[agent/LOOP.md](agent/LOOP.md)** | Autonomous iteration protocol |
|
||||
|
||||
Kept out of the README body so this stays a focused entry point.
|
||||
|
||||
Reference in New Issue
Block a user