Development

How the repository is laid out, how to change it safely, and where the real engineering documents live.

The short version

git clone https://github.com/drawmeanelephant/DipshitOS.git
cd DipshitOS
zig build            # build
just verify-portable # class A (mirrors CI)
just verify-vz       # class B (Apple silicon, real VMs)

Read AGENTS.md before changing anything — it is the project's rulebook.

The two docs surfaces

There are deliberately two documentation surfaces:

  1. This site (site/) — the public front door, compiled by Boris.
  2. The engineering warehouse (docs/) — claims, decisions (ADRs), gate inventory, hardware contract, status, roadmap, logs, and archived prompts.

The warehouse is source material, not automatically-published pages. The public site promotes and summarizes it, and links to the canonical files on GitHub rather than duplicating them.

Where to look for ugly detail

  • docs/decisions/ — ADRs 0001–0007 (the binding decisions: kernel proper, runtime function tables, MMU debt boundary, the syscall ABI).
  • docs/claims/ — per-claim scope and evidence.
  • docs/hardware-contract.md — observed vs inferred hardware facts.
  • docs/gate-inventory.md — the full gate table.
  • docs/status.md — the canonical living status.