Development
| Status | Applies to | Owner |
|---|---|---|
| Pre-release draft | main branch as of 2026-06-30 development workflow index | Development maintainers |
Use uv for dependency management and just for project commands. Run
just help before choosing a task-specific recipe.
Start Here
just dev-bootstrap
just doctor
For GPU-capable development:
just dev-bootstrap-gpu
just doctor-jax
Server-specific CPU/GPU routing, SLURM nodes, caches, and environment variables belong in Server Gauss SLURM. Reduced-toolchain local setup belongs in No-Nix Development.
Common Checks
Login-node-safe local checks:
just check-local
just test-local-focused
Repository-wide checks:
just format
just lint
just typecheck
CI checks the README code-size summary but does not push refresh commits to
protected main. After changing tracked files under crates/, src/, or
README.md, run scripts/update_readme_code_summary.py with cloc available
and commit the updated README in the same branch.
Full CPU validation, GPU validation, large test suites, and native builds should run through the appropriate local or SLURM workflow for the current host. See Testing and Parity and Server Gauss SLURM.
Documentation
Serve and build the Zensical site:
just docs-serve
just docs-build
just docs-check
When changing user-facing CLI behavior, configuration, input/output contracts,
runtime behavior, performance assumptions, or deployment workflow, update the
relevant page under documentation/public/ in the same branch. When changing
development workflows or docs infrastructure, update the relevant page under
documentation/development/.
Generated documentation_rendered_website/ output is local build output and is
not committed.
See Documentation Operations for publishing setup, theme configuration, GitHub Pages settings, and documentation workflow behavior.
Development Contracts
| Topic | Page |
|---|---|
| Code style and review rules | Style Guide |
| Architecture map | Architecture |
| Architecture cleanup and Rust migration | Architecture Cleanup |
| CLI/TOML configuration frontend | Configuration Frontend |
| Native BGEN, sample, output, and manifest boundaries | Native I/O |
| Native integer boundary policy | Integer Policy |
| Native integer type audit | Integer Type Audit |
| JAX quantitative, binary, and Firth kernels | Compute Kernels |
| Testing, correctness, and parity expectations | Testing and Parity |
| Pre-release REGENIE Step 2 parity gate | REGENIE Parity Suite |
| Benchmark taxonomy and protocols | Benchmarking |
| Telemetry and logging architecture | Telemetry |
| Development tooling | Tooling |
| Justfile recipes | Justfile Command Reference |
| Roadmap | Roadmap |
Internal scratchpad notes are direct-path development material and may be stale.