Skip to content

Design notes ​

Tracked, citeable design records: the model behind a mechanism, the options weighed, and the decisions taken. Nothing here is normative -- a note binds no implementation, and points at the spec for the normative rows rather than restating them. A note opens with a status line stating where its subject stands, from a direction still open to a decision taken and built.

Index ​

NoteStatus
abort-marker-retryable-class.mdDesign only, not built; waits on an observed base rate. The classless default is final.
agent-hooks-and-scripts.mdDecided and built; the rationale and stated limits behind the agent hooks and session scripts whose headers state only their contract.
app-shell-service-worker.mdDecided and built.
backup-import-per-exchange-guard.mdDecided on the maintainer's ruling and built.
bound-transformed-value.mdDecided and built, by a 3-panelist design panel.
broker-runtime-closure.mdDecided and built.
browser-sftp-proxy.mdDesign only, not built; the product scope and seven other choices are left open.
cascade-fan-out.mdDirected; the spec has landed, the realization is pending.
claude-md-spawn-cost.mdDecided and built; what each spawn type receives, the orchestrator-only share under two partitions, and the split taken against it.
cli-webrtc-attempt-cycle.mdDecided on the maintainer's ruling and built, after a real-broker measurement.
cli-webrtc-stack.mdDecided and built.
cloudflare-turn-sizing.mdMeasured; cost per GB unmeasured, and nothing decided or built.
column-name-display.mdDecided and built; why the operator's own column names are isolated rather than escaped, and what isolation leaves open.
comment-history-narration-check.mdDecided and built; the corpus measurement and the false-positive rate behind the check's phrase list.
connect-timeout-prior-art.mdDecided and built; what curl and OpenSSH bound, measured, and the three decisions taken on it.
connection-error-kind-taxonomy.mdDecided and built; each classification records the condition that would reopen it.
connection-per-poll-sftp.mdShipped.
console-announce-and-focus.mdDecided and built, by a 3-panelist design panel deciding 2-1.
console-signing-identity-custody.mdDecided on the maintainer's ruling; the refusal is built, the identity-location option is not.
core-dist-cache-buildinfo.mdDecided and built; supersedes an earlier cache-side decision.
cosign-keyless-signing.mdDecided and built.
cross-workspace-test-material.mdDecided and built.
deduplicate-matching-semantics.mdSpecified, and run end to end: the one-sided cardinalities under both linkage strategies, the both-sided one under cascade.
default-linkage-rule-set.mdDecided and built.
failure-cause-catalog.mdDecided and built.
fan-out-matching-resolution.mdBuilt under single-pass; the cascade realization stays open work.
fips-provider-surface.mdMeasurement, plus two decisions taken on it; whether to pursue a FIPS claim at all remains open.
fips-variant-image.mdDecided, built, and published.
folded-column-name-lookup.mdDecided on the maintainer's ruling and built; the options weighed and what the fold changes for a configuration with no metadata block.
hash-keyed-value-lookup.mdDecided and built; the three lookup keys measured at 2^24 and why the hash was taken.
hosted-environment-opentofu.mdDecided and applied; the resources it held no longer exist.
key-establishment-fips-boundary.mdDecided and implemented; the post-quantum hybrid and dual signing wait on three runtimes, measured 2026-10-28.
linkage-rule-catalog.mdProposed; bands the shipped keys and proposes the rest, each rule with its precision band and evidence.
linkage-rule-grounding.mdProposal, pending adoption -- nothing here is adopted or shipped.
lockless-rendezvous-barrier.mdWeighed and set aside; the shipped symmetric barrier stands.
managed-exchange-design.mdDecided and built; the grace window is proposed in rotation-hardening.md and not built.
one-sided-disclosure.mdResolved - shipped as the opt-in single-pass linkage strategy (the cascade stays the default).
one-sided-fuzzy-expansion.mdDecided, built, and applied.
operator-message-control-characters.mdDecided and built.
output-directory-removal-lock.mdMeasurement backing the retry's wall-clock budget.
payload-as-agreed-terms.mdDecided on the maintainer's ruling, after a 3-panelist design panel; not built.
portable-configuration-readers.mdRule decided and specified, the unread-key refusal built; the audit of each reader and the two gaps it leaves open.
prebuild-provenance.mdDecided, built, and armed against a fork that attests.
psi-c-count-only.mdDirected by the maintainer's rulings; the spec has landed, the rebuild is pending, and the shipped build is the earlier one-key construction. Missing-field conditions and single-pass are admitted; candidate sets stay refused as an interim limit.
rebase-reattestation.mdDecided on the maintainer's ruling and built; the fourth mechanical re-attestation path and the limits it accepts.
receipt-run-binding.mdResolved - built.
receipt-signing-fips-boundary.mdDecided.
record-durability-point.mdResolved - built.
rename-to-alcove.mdDecided on the maintainer's rulings and built.
repo-check-scripts.mdDecided and built; the rationale and stated limits behind the repository check scripts whose headers state only their contract.
reported-failure-cause.mdDecided on the maintainer's ruling and built; the two shapes declined, and what the block holds apart that escaping does not.
rotation-hardening.mdDesign only, not built; proposed for ratification, with two choices left open.
rule-set-citation-verdict.mdResolved - built, then withdrawn on the maintainer's ruling removing the citation.
sftp-adapter-state-machine.mdShipped.
shared-consent-summary.mdShipped.
signing-identity-custody.mdDecided and built, by a 3-panelist design panel converging 3-0.
standing-relay-delivery.mdDecided, the reference is written, and the first deployment has driven a relayed exchange through it.
turn-provisioning-governance.mdSurveyed, with a recommendation per profile; nothing decided or built, and the configuration shape left to separate work.
wasm-parallel-evaluation.mdBoth arms measured, and the browser direction decided: Web Worker sharding, with the pthreads/SIMD build declined; the web exchange runs the worker pool for the party creating the request, one worker for the party answering it and on macOS.
web-server-runtime-role.mdEnd state reached for the public deployment: a static site, with the framework's server half removed; the console keeps its server.
web-websocket-transport.mdDesign only, not built; the WebSocket relay for networks that stop TURN recommended first, the browser SFTP forks re-answered for the public web application, and seven choices left open.
webrtc-frame-structure-envelope.mdDecided and built, by a 3-panelist design panel converging 3-0 on the retirement and 2-1 on the ceiling.
webrtc-memory-measurements.mdMeasurement history; the current figures are in the spec.
webrtc-outbound-packer.mdDecided and built, by a 3-panelist design panel deciding 2-1; the measured ceiling it removes and the one it leaves.
webrtc-relay-deployment.mdMeasured, with a recommendation and a proposed epic; the recommendation is now deployed and verified against the standing relay.

Each note states its full status at its own top; this table is a pointer, not a restatement.

The maturity ladder:

  • scratch/ (gitignored) - personal, throwaway thinking, no audience.
  • docs/notes/ (here) - tracked, citeable design records; non-normative.
  • docs/ proper - the formal, living documentation, in two tiers:
    • docs/ (overview) - conceptual and operational documents for program officers, security reviewers, compliance officers, IT staff, and new contributors.
    • docs/spec/ - the technical specification tier: wire formats, byte encodings, protocol internals, and implementation-level design, written for implementors and auditors. See docs/spec/README.md for the index and routing guide.

Naming: notes use lowercase-kebab filenames to distinguish them at a glance from the SCREAMING_CASE formal specs in docs/ and docs/spec/.