All checks were successful
Check / eval (push) Successful in 4m28s
The repo is maintained by agents from multiple vendors, so agent instructions move out of vendor-specific locations into shared, git-tracked markdown: - AGENTS.md is the new entry point for any harness; CLAUDE.md becomes a symlink to it (Claude Code keeps working unchanged). - Skill bodies relocate to agent/: VERIFICATION.md (the enforcement rules, ex .claude/skills/nomarchy), DELEGATION.md (capability tiers light/standard/frontier, scout/runner role contracts, token economy, parallel fan-out — consolidates the CLAUDE.md model table, LOOP.md's economy section, and skill §6.5 into one place; vendor model names survive only in the per-harness mapping table), THEME-DESIGN.md (ex .claude/skills/theme, which previously lacked frontmatter). - .claude/ shrinks to a thin Claude Code adapter: settings, subagent defs, and skill shims that route into agent/. - Maps updated: agent/README.md (instructions vs state vs adapters), docs/README.md, README.md layout tree. Cleanup: stale old_distro .gitignore entry dropped (dir long gone); local result*/__pycache__ artifacts removed; JOURNAL.md rotated (29 recent entries kept, 120 older moved to agent/JOURNAL-ARCHIVE.md, rotation rule documented in the header). Verification: V0 (docs/meta only) — nix flake check --no-build exit 0 with the tracked symlink; grep sweep confirms no vendor model names outside DELEGATION.md's mapping table. Co-Authored-By: Claude Fable 5 <noreply@anthropic.com>
42 lines
1.8 KiB
Markdown
42 lines
1.8 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 |
|
|
| [OMARCHY.md](OMARCHY.md) | Users | Coming from Omarchy — bindings/theme/install/config map |
|
|
|
|
## Related (not under `docs/`)
|
|
|
|
| Path | Role |
|
|
|------|------|
|
|
| [../AGENTS.md](../AGENTS.md) | Agent entry point, any vendor/harness (`CLAUDE.md` symlinks to it) |
|
|
| [../agent/README.md](../agent/README.md) | Agent instructions + **executable** loop state: BACKLOG, LOOP, VERIFICATION, … |
|
|
| [../.claude/](../.claude/) | Claude Code adapter only: permissions + subagent/skill shims |
|
|
|
|
## 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 § …`.
|