Development setup
Run this documentation site and understand the separate Zig development environment.
Status: Development. The documentation website runs independently of the Zig engine. There is no packaged database release to install at this checkpoint.
Run the website
Use Go 1.25 or newer, matching the website module's minimum version. From a local copy of this repository:
cd website
go run . -repo .. -addr 127.0.0.1:8088
Open http://127.0.0.1:8088. The repository argument tells the server where to read version metadata, the changelog and the documentation catalog. Binding to loopback keeps this development instance local.
Run the website checks from the same directory:
go test ./...
The Go server uses the standard library. HTMX and the fonts are served from local assets; the browser does not need a package manager or a third-party asset host. Read the dependency contract.
Understand the engine toolchain
The engine pins Zig 0.16.0 in .zig-version. The repository wrapper checks the selected compiler before forwarding commands. It accepts RURAL_ZIG, a matching zig on the executable search path, or the repository's documented development cache convention.
From the repository root, the compiler check is:
zsh scripts/zig.sh version
When engine development resumes, the intended whole-project build and verification commands are:
zsh scripts/zig.sh build
zsh scripts/zig.sh build test --summary all
Paused checkpoint, 19 September 2026: the latest complete Zig build failed in src/protocol/local.zig because the development facade used an incompatible ObjectMap API. That issue was preserved when engine work paused. These commands identify the workflow; they are not a claim that the current checkout passes it. Consult the status record and changelog for recorded progress.
Choose the right evidence
Module tests establish specific behavior such as snapshot lifetime or journal recovery. A historical passing suite does not certify a newer checkout, and a successful compilation would not by itself prove a usable database.
The local application milestone still requires a real consumer, verified restart and restore behavior, usable CRUD and query interfaces, and the Oracle path. Check project status before treating any example as an available feature.