ReviewOS

home-lang/home-os

§13 Docs realignment: README honesty, IMPLEMENTATION_STATUS.md, banners

#27
Closed chris opened this 8 days ago ·
8 days ago

Phase 0 documentation tasks (MASTER_PLAN §13):

  1. README.md: remove overclaiming header; honest baseline paragraph; fix project-structure diagram (references nonexistent kernel/src/boot.zig)
  2. Create auto-generated IMPLEMENTATION_STATUS.md (parse %, boot status, stub register excerpt) — generator script so it can't drift
  3. Fold missing HOME_KERNEL_FEATURES.md intent into IMPLEMENTATION_STATUS.md; update referrers (CLAUDE.md, docs/adr/0001-*)
  4. Add status banner to aspirational guides (docs/USER_MANUAL.md, docs/INSTALL_RPI5.md, peers): "Status: describes target behavior; see IMPLEMENTATION_STATUS.md"
  5. Reset CHANGELOG.md / RELEASE_NOTES.md at v0.1

Also renames grep-tests under tests/ → static-checks/ per §12. Part of #21.

Sign in to comment on this issue.