02d7baeb7c
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.
41 lines
1.7 KiB
Markdown
41 lines
1.7 KiB
Markdown
# Docs map
|
|
|
|
Where human and agent documentation lives. **Do not** invent a third
|
|
tree for the same facts.
|
|
|
|
| Path | Audience | Role |
|
|
|------|----------|------|
|
|
| [../README.md](../README.md) | Everyone | What Nomarchy is, install, options tables |
|
|
| [VISION.md](VISION.md) | Maintainers + agents | Product north star toward **v1.0** and beyond — themes, not a task queue |
|
|
| [ROADMAP.md](ROADMAP.md) | Maintainers + agents | Design/decision records + shipped log (historical ✓) |
|
|
| [HARDWARE.md](HARDWARE.md) | Users + agents | Firmware, profiles, drivers, unsupported machines |
|
|
| [TESTING.md](TESTING.md) | Maintainers + agents | Verification ladder, honesty rule, ISO/VM recipes |
|
|
| [RECOVERY.md](RECOVERY.md) | Users | Broken theme/desktop/boot → undo |
|
|
| [OVERRIDES.md](OVERRIDES.md) | Users | Downstream Nix overrides |
|
|
| [MIGRATION.md](MIGRATION.md) | Users | Existing NixOS → Nomarchy without reinstall |
|
|
|
|
## Related (not under `docs/`)
|
|
|
|
| Path | Role |
|
|
|------|------|
|
|
| [../agent/README.md](../agent/README.md) | **Executable** agent loop state: BACKLOG, LOOP, MEMORY, … |
|
|
| [../CLAUDE.md](../CLAUDE.md) | Agent entry point (any harness that reads it) |
|
|
| [../.claude/](../.claude/) | Claude Code only: permissions + subagent defs |
|
|
|
|
## How work flows
|
|
|
|
```
|
|
VISION (what we want the product to feel like)
|
|
│
|
|
▼ human triages slices into…
|
|
BACKLOG (what's next, ordered — agents execute only this)
|
|
│
|
|
▼ lasting design notes after ship →
|
|
ROADMAP ✓ entries
|
|
```
|
|
|
|
Agents **do not** implement directly from VISION or ROADMAP. They take
|
|
the top actionable item in `agent/BACKLOG.md` (see `agent/LOOP.md`).
|
|
They **may** append PROPOSED pitches that reference `VISION § …` or
|
|
`ROADMAP § …`.
|