Files
Nomarchy/docs
Bernardo Magri a818c19a4e
All checks were successful
Check / eval (push) Successful in 4m21s
chore: v1-prep hygiene sweep — LICENSE (MIT), fixtures under tools/, doc staleness
Three-way audit ahead of v1 (structure/necessity, docs-vs-code drift,
mechanical checkers) came back clean: zero dead files, zero doc hard
errors, all 92 options documented, all consistency checkers green, no
untracked files. What it did surface, fixed here:

- LICENSE was missing entirely — the one hard launch blocker. MIT
  (Bernardo's call), pointer at the README foot.
- checks/ was the only top-level dir outside the documented layout rule;
  its two state-legacy-name fixtures moved to tools/fixtures/ (Bernardo
  chose move over documenting an exception), flake.nix refs + drift
  messages updated.
- Doc staleness: two leftover "theme-state" leads (HARDWARE.md,
  REQUIREMENTS.md) now say state.json; VISION Theme C charge-limit row
  gets its ✓; VISION agent-slices datestamp bumped.
- The idle.nix miniTransition duplication (same binary name, lossy
  subset of the real display-transition tool) is deliberately NOT
  refactored here — filed as PROPOSED #150 with the audit evidence.

Wallpapers-in-repo (97 MB) is the known LATER artifact-split item, not
re-filed.

Verification: V0 — nix flake check --no-build green after the fixture
move (state-legacy-name's eval asserts exercise the new paths); doc
edits prose-reviewed. Audits by three Sonnet passes; triage on Fable.

Co-Authored-By: Claude Fable 5 <noreply@anthropic.com>
2026-07-17 16:20:39 +01:00
..

Docs map

Where human and agent documentation lives. Do not invent a third tree for the same facts.

Path Audience Role
../README.md Everyone What Nomarchy is, install, options tables
REQUIREMENTS.md Users + agents Minimum system requirements (GPU/OpenGL, RAM, disk, UEFI)
VISION.md Maintainers + agents Product north star toward v1.0 and beyond — themes, not a task queue
ROADMAP.md Maintainers + agents Design/decision records + shipped log (historical ✓)
HARDWARE.md Users + agents Firmware, profiles, drivers, unsupported machines
TESTING.md Maintainers + agents Verification ladder, honesty rule, ISO/VM recipes
RECOVERY.md Users Broken theme/desktop/boot → undo
OVERRIDES.md Users Downstream Nix overrides
MIGRATION.md Users Existing NixOS → Nomarchy without reinstall
OMARCHY.md Users Coming from Omarchy — bindings/theme/install/config map
Path Role
../AGENTS.md Agent entry point, any vendor/harness (CLAUDE.md symlinks to it)
../agent/README.md Agent instructions + executable loop state: BACKLOG, LOOP, VERIFICATION, …
../.claude/ Claude Code adapter 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 § ….