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.
110 lines
6.4 KiB
Markdown
110 lines
6.4 KiB
Markdown
# HAL — HQ
|
|
|
|
The single source of truth for what the HAL mesh **is**, what it is **becoming**, and
|
|
why. Implementation lives in `modules/`; the reasoning behind it lives here.
|
|
|
|
## Structure
|
|
|
|
| Folder | Purpose |
|
|
|--------|---------|
|
|
| [`00-GENESIS`](00-GENESIS/) | Mission, foundational context, the rules that hold across the mesh, the repository map, and the process playbooks. The northern star for every decision. |
|
|
| [`01-RESEARCH`](01-RESEARCH/) | Active and historical investigations, before they harden into design. |
|
|
| [`02-DESIGN`](02-DESIGN/) | The authoritative specification, in two layers: [`00-as-is`](02-DESIGN/00-as-is/) — the mesh that exists — and [`01-to-be`](02-DESIGN/01-to-be/) — the one being built toward. |
|
|
| [`adr`](adr/) | Numbered decision records, in the order the decisions were taken — what was chosen, and what was rejected. |
|
|
| [`04-ISSUES`](04-ISSUES/) | The front door for "something is wrong" at the level of design or governance. |
|
|
| [`DECISIONS.md`](DECISIONS.md) | The ledger: every decision as it was taken, indexing the records and holding the ones too small to warrant one. |
|
|
|
|
## The flow
|
|
|
|
```
|
|
idea ──► 01-RESEARCH ──► decision (adr/) ──► 02-DESIGN/01-to-be ──► built (code repo)
|
|
│ │ │
|
|
│ │ └─► 02-DESIGN/00-as-is once shipped
|
|
│ └────► abandoned (recorded, kept)
|
|
└─(small/obvious, decision recorded in DECISIONS.md)────► 02-DESIGN directly
|
|
|
|
symptom ──► 04-ISSUES ──► diagnosis ──► code-repo fix and/or design amendment
|
|
|
|
00-GENESIS/how-we-build.md ──► sync ──► the constitution the mesh injects into design sessions
|
|
```
|
|
|
|
Implementation lives in the code repositories — see
|
|
[`00-GENESIS/repos.md`](00-GENESIS/repos.md). Every workflow is a playbook in
|
|
[`00-GENESIS/process/`](00-GENESIS/process/); agents operate through them and not outside them.
|
|
|
|
## Rules
|
|
|
|
- Markdown only.
|
|
- No new top-level folders without explicit confirmation.
|
|
- Knowledge flows `GENESIS → RESEARCH → DESIGN`. Research graduates into design only after
|
|
analysis against GENESIS confirms alignment, and only through a recorded decision.
|
|
- **Status lives in frontmatter**, never in a central status file. Cross-cutting views are
|
|
generated on demand, never hand-maintained.
|
|
- **GENESIS and DESIGN are instance-agnostic.** They describe the mesh as a concept — no
|
|
machine names, no counts, no topology. A reader must not be able to tell how many nodes
|
|
the author happened to have.
|
|
- **RESEARCH describes real observations, but never identifies the mesh it observed.**
|
|
Evidence is what makes research worth reading, and the shape of a finding survives
|
|
anonymisation intact — *a node publicly named but behind a household NAT* carries the whole
|
|
lesson without naming anything.
|
|
- **The as-is layer records what is, not what should be** — including behaviour nobody would
|
|
choose again. A layer that keeps only the good decisions is a brochure.
|
|
- A document that states a rule about the mesh should say how that rule is **checked**.
|
|
This repository has a rule requiring every capability-exposing module to declare the core
|
|
runtime as a dependency; zero modules do. An unenforced rule is indistinguishable from a
|
|
wrong one.
|
|
|
|
### This repository is public
|
|
|
|
Written for a reader who is not its author and has no access to the mesh it describes.
|
|
Concretely, nothing here may contain:
|
|
|
|
- **routable addresses, real domain names, hosting providers, or node names** — use the
|
|
documentation ranges (RFC 5737 `203.0.113.0/24`, RFC 1918) and role names such as `anchor`,
|
|
`home-server`, `workstation`, `laptop`
|
|
- **absolute paths** from anyone's machine, usernames, home directories, or email addresses
|
|
- **credentials in any form**, including lengths or hashes of live secrets
|
|
- **operational detail that is only useful to an attacker** — which host is the VPN hub, on
|
|
which port, which node is reachable only through a forwarded port
|
|
|
|
Private-range addresses and the overlay plan are fine: they describe a pattern, not a target.
|
|
|
|
The test is whether a paragraph would still teach something to a stranger running an entirely
|
|
different mesh. If it would, it belongs. If it only makes sense to someone who knows this
|
|
particular installation, it is either a note in the wrong place or a disclosure.
|
|
|
|
## Why this is its own repository
|
|
|
|
It began inside the code repository, on the reasoning that HAL already has a mesh-native
|
|
knowledge store and that adding a fourth knowledge system would repeat the mistake this
|
|
folder was created to fix.
|
|
|
|
**That objection was about a fourth knowledge *system*, and the answer offered was indexing
|
|
rather than location** — that these documents would be indexed into the knowledge base, so a
|
|
symptom search returns them beside everything else. One source, many surfaces. Where the source
|
|
is authored is then a separate question.
|
|
|
|
**That indexing does not exist.** It was checked on 2026-08-23 and returns nothing; it appears
|
|
never to have existed. Until it does, the objection stands unanswered and this repository is
|
|
the fourth knowledge system it was argued not to be. Recorded as
|
|
[`04-ISSUES/006`](04-ISSUES/006-hq-is-not-indexed-into-the-knowledge-base/00-report.md), and
|
|
left standing here rather than quietly reworded, because a claim that held up a decision and
|
|
was never checked is precisely the failure this repository exists to name.
|
|
|
|
Answered separately, a repository of its own is the better home:
|
|
|
|
- **The cadence is different.** A decision changes when thinking changes, not when code
|
|
changes. Tying documents to a code branch means they merge on the code's schedule.
|
|
- **The reviewers are different.** A design argument is not reviewed the way an
|
|
implementation is, and it should not queue behind a build.
|
|
- **The scope is wider than one repository.** [ADR 0015](adr/0015-mesh-brokers-nodes-host-agents-think.md) sends most modules out of the
|
|
monorepo entirely. Documentation that governs several repositories cannot live inside one
|
|
of them.
|
|
|
|
The trade is real and worth naming: a change to a document and the change to the code it
|
|
describes can no longer land in one commit. Keeping them honest is a discipline now rather
|
|
than a mechanism — which is why [`DECISIONS.md`](DECISIONS.md) records decisions as they are
|
|
taken, and why a document that states a rule should say how the rule is checked.
|
|
|
|
Recorded as decision 27 in [`DECISIONS.md`](DECISIONS.md).
|