Files
hq/03-DESIGN
jschoubben 9e99e9562b Designs 08 and 33: the firewall seat's control verbs beside the derived ports (the operator, 2026-11-21)
The operator decided that the packet filter's module must have tools to
control it beside what is derived from the modules' declarations: deriving
every open port from listens left no way to open a port no manifest names.

Design 08 section 4 keeps the derived ports as the automatic part and adds
allowances set by hand; the node-engine stays the one renderer, asks the
holder's allowed verb at every compose, refuses the compose and keeps the
loaded filter when it gets no answer, and renders allowances only on a
converged node. Design 33 gives the seat allow, disallow and allowed,
widens rules, and adds the event allowances-changed and the holder's
state: one allowance per protocol, port and interface, removed and
journalled at its expiry. Both follow ADR 0683 and design 47 H's lead
answers H-A-304, H-A-305, H-A-307 and H-A-308.

Both designs are put in playbook 02's shape: their new lines live in
milestone parts, and design 08's adoption lines move to a delivered part
so the main file stays under 80 KB. The glossary gains allowance.
2026-11-21 20:33:52 +01:00
..

03-DESIGN

The authoritative specification. Implementation is built against what is written here.

Two layers

Folder What it is
00-as-is/ The mesh that exists today. Shipped behaviour, described as it is — including behaviour nobody would choose again.
01-to-be/ The mesh being built toward. Every statement traceable to a decision record in the knowledge base (ADR 0290).

They are never mixed. 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.

When a to-be design ships, it does not move. Its as-is counterpart is written or updated, the to-be document's status becomes implemented, and both stand — one describing what runs, the other recording what was intended. Deleting the intention loses the reasoning, which is the expensive half.

Frontmatter

Every design document (not the READMEs) carries:

---
layer: as-is | to-be
status: designed | in-progress | implemented | abandoned
code: []                 # owning code repo(s), from 00-META/repos.md
updated: YYYY-MM-DD      # date of the last status change, not of text edits
decisions: []            # the decision records this document rests on, each "ADR NNNN"
---

For an as-is document, status: implemented is the normal state — it describes something that runs — and code: names where that implementation lives.

Status changes when implementation state changes, never because design text was edited. An implemented claim must be defensible from the owning repository's main branch, not from intent. If it cannot be checked, it is in-progress.

Cross-cutting views are generated from this frontmatter by the hq-status skill and never written to disk.

What belongs here

Functional analysis, architectural description, and specification — prose and diagrams only, no code. A manifest field may be named; a manifest may not be pasted. A document enters the to-be layer only after the decision behind it is recorded in the knowledge base and the research that produced it is closed.

Subfolders are encouraged where a layer grows enough to need them.