helix_store

Helix Store.

This README is the canonical starting point for all project documentation (§11.4.212). Every project document is reachable from here, directly or transitively.

Status

This repository currently contains no source code. It holds the project's governance wiring and its archived design corpus. See docs/guides/HELIX_STORE_CONSTITUTION.md for what is and is not yet ratified.

Governance

Document	Purpose
CLAUDE.md	Project CLAUDE.md — inherits constitution/CLAUDE.md
AGENTS.md	Project AGENTS.md — inherits constitution/AGENTS.md
docs/guides/HELIX_STORE_CONSTITUTION.md	Project constitution — extends constitution/Constitution.md
constitution/	Helix Universal Constitution (submodule, canonical root)

The canonical universal rules live in the constitution submodule (HelixConstitution). Project-specific rules live in this repository. The constitution wins on any disagreement (§11.4.35).

Verification

Inheritance from the constitution is mechanically verified, not claimed:

Script	Purpose
tests/pre_build_verification.sh	Pre-build gate orchestrator — runs everything below
tests/test_constitution_inheritance.sh	Constitution inheritance gate (the invariants)
scripts/testing/meta_test_false_positive_proof.sh	§1.1 paired mutations — proves the gate catches regressions
scripts/testing/install_git_hooks.sh	Installs the pre-commit hook running the gate

Run the full verification:

bash tests/pre_build_verification.sh

After a fresh clone, initialise the submodule and install the hook (git hooks are not version-controlled and do not propagate on clone):

git submodule update --init --recursive
bash scripts/testing/install_git_hooks.sh

Upstreams

This project mirrors to four upstreams (GitHub primary, GitLab, GitFlic, GitVerse), declared in upstreams/ and configured via the constitution's install_upstreams.sh (§2.1, §11.4.36):

bash constitution/install_upstreams.sh

Design corpus

The Helix Store design lives in docs/research/mvp/materials.zip — a 56-file helixstore/ tree covering the product vision, a 191-feature catalog across 16 domains, the permission model, architecture (ARCH-001 with ADR-001…ADR-019), the database schema and SQL, API specifications, client strategy, the repository integration plan (INTEG-001/INTEG-002), the risk register, and the M1–M24 delivery roadmap.

It is archived rather than extracted, so repository-wide search does not reach it. To read it, extract to a scratch directory outside the repository.