jschoubben
702efca6bb
HQ held only the to-be. Every reader had to already know the system the decisions were about, and an as-is claim had nowhere to live except inside an intention. Adds 02-DESIGN/00-as-is — eleven documents written from the implementation and the operational record, not from intent, including the parts nobody would choose again. The two existing designs move under 01-to-be. Layers are declared in frontmatter and never mix: a design that ships does not move, its as-is counterpart is written, and both stand. Back-fills adr/0001-0014 for decisions taken in implementation and never recorded — the broker, the module abstraction, the mesh database, managed files, provisioning, migrations, the workspace removal, failing loudly, the constitution, application placement, linking, the employee model, the artifact, the three silos. Each marked reconstructed, dated from the history, and citing the evidence it was recovered from. The two existing records renumber to 0015 and 0016 so the ledger runs oldest first; 0017 extends 0015 to modules outside the core, principle only — the domain list is deliberately not invented here. how-we-build.md becomes the source of the mesh constitution, with a sync playbook, so the enforced copy stops being the only one that is true. Process becomes explicit: five playbooks, eight thin skills that defer to them, a repository map, and AGENTS.md with CLAUDE.md as its include. The five Observations become 04-ISSUES 001-005 where they can be owned and closed. 006 is new and uncomfortable: HQ is not indexed into the knowledge base. That claim is what decision 27 rests on, it was never checked, and the README now says so instead of repeating it. Also corrects the ADR index into something generated, the "02-DESIGN is empty" claim, the VISION.md pointer that did not survive the repo split, and a note asserting the symlink rule was contradicted — it was a misreading; the rule forbids hand-made links, the installer links by design.
2.9 KiB
Agent instructions — hal-hq
This repository is the source of truth for the HAL mesh's mission, research, design and
decisions. Implementation lives in the code repositories (see
00-GENESIS/repos.md).
Before changing anything here, read the playbooks in
00-GENESIS/process/ — every workflow (research, graduation, design
amendment, issues, build handoff, constitution sync) is documented there, and agents operate
through them. Thin skills in .claude/skills/ wrap these playbooks for invocation
(hal-new-research, hal-graduate, hal-new-issue, hal-diagnose, hal-amend-design,
hal-handoff, hal-sync-constitution, hal-status); each defers to its playbook as
authoritative and adds only the mechanical scaffolding.
Ground rules
- Markdown only. No new top-level folders without explicit confirmation.
- Status lives in YAML frontmatter — on research overviews (
status,became), design docs (layer,status,code,updated), issue reports (status,located-in,fixed-by,amended-design) and decision records (status,date,deciders). Never create a central status file; cross-cutting views are generated from frontmatter. adr/records are immutable. Supersede with a new record; never edit meaning. Fixing a broken link or path is allowed.- Design docs are prose and diagrams only — no code. A manifest field may be named; a manifest may not be pasted.
- Two layers, never mixed.
02-DESIGN/00-as-is/describes the mesh that exists;02-DESIGN/01-to-be/describes the one being built toward. Every design doc says which it is inlayer:. A statement about the future does not belong in an as-is document, and an as-is document is never edited to describe an intention. 00-GENESIS/how-we-build.mdis the source of the mesh constitution. The knowledge-base constitution page is derived from it — see playbook05-constitution-sync.md. Never edit the derived page directly.
This repository is public
Nothing here may contain routable addresses, real domain names, hosting providers, node
names, absolute paths, usernames, credentials, or operational detail useful only to an
attacker. Use documentation ranges (RFC 5737, RFC 1918) and role names — anchor,
home-server, workstation, laptop, the build node, the broker node.
The test: would this paragraph still teach a stranger running an entirely different mesh?
If yes, it belongs. If it only makes sense to someone who knows this installation, it is
either a note in the wrong place or a disclosure. The full rule is in
README.md.
A rule states how it is checked
If a document states a rule about the mesh, it says how that rule is verified. An unenforced rule is indistinguishable from a wrong one, and costs more, because people believe it.