aboutsummaryrefslogtreecommitdiffstats
path: root/docs
diff options
context:
space:
mode:
authortv <tv@krebsco.de>2026-11-16 17:08:28 +0000
committertv <tv@krebsco.de>2026-11-16 18:28:07 +0100
commite7f8b368db441dbd2c91b08e7e04fa34bed01a1a (patch)
tree7351891ce1527fc0f90effb342dd9afa339b797b /docs
parent62037cc131ab52c926debeacbef86d7728ecda2e (diff)
docs: the store and the federation say what of them is built
store.md, federation.md and federation-tests.md said none of them was built; the store held in memory is, with a fold made for its tests and their properties.
Diffstat (limited to 'docs')
-rw-r--r--docs/federation-tests.md4
-rw-r--r--docs/federation.md12
-rw-r--r--docs/store.md19
3 files changed, 18 insertions, 17 deletions
diff --git a/docs/federation-tests.md b/docs/federation-tests.md
index 01382f8..4ab3f64 100644
--- a/docs/federation-tests.md
+++ b/docs/federation-tests.md
@@ -1,7 +1,7 @@
# Testing the store and the federation: a plan
-A plan, not what the code does: none of this is built. It says how the store
-([`store.md`](store.md)) and the federation ([`federation.md`](federation.md)) are
+A plan, built stage by stage (By stage): so far, the store's tests. It says how the
+store ([`store.md`](store.md)) and the federation ([`federation.md`](federation.md)) are
tested, so that nothing in continuum breaks the federation, and no change made later
breaks it apart. It is the contract the code is built to: a stage is done when its tests
are.
diff --git a/docs/federation.md b/docs/federation.md
index e2f83e1..46404d9 100644
--- a/docs/federation.md
+++ b/docs/federation.md
@@ -1,11 +1,11 @@
# Federation: a design
-A design, not what the code does: none of this is built. It says how a swarm can be kept
-by parties that don't trust each other, for a first use: the krebs registry
-([krebs/kartei](https://github.com/krebs/kartei)), today plain files in a git repository
-that one maintainer merges into. What it is for is narrow: to hand out identifiers
-(names, addresses, keys), and to give every party a namespace of its own that everyone
-reads.
+A design, built stage by stage (Stages): so far, the store it builds on, held in memory.
+It says how a swarm can be kept by parties that don't trust each other, for a first use:
+the krebs registry ([krebs/kartei](https://github.com/krebs/kartei)), today plain files
+in a git repository that one maintainer merges into. What it is for is narrow: to hand
+out identifiers (names, addresses, keys), and to give every party a namespace of its own
+that everyone reads.
It asks as little as it can of continuum and promises the least that makes a federation
possible. A federation that cooperates settles fast; one that doesn't comes apart, and
diff --git a/docs/store.md b/docs/store.md
index 81f508f..1531fa4 100644
--- a/docs/store.md
+++ b/docs/store.md
@@ -1,14 +1,15 @@
# The store: a design
-A design, not what the code does: none of this is built. The store holds events. Each
-event is named by the hash of its bytes and names the events it builds on; it is judged
-where it was written, at that history, so every node judges it alike; and the events a
-node holds read as one state. The store starts from a checkpoint, the state at some
-heads written down, and holds what came after it; moving to a later checkpoint, a node
-forgets what matters no more, so that it holds what is relevant and nothing else. What
-the events are, how one is judged, what they read as and when the store moves to a
-checkpoint is a **fold**'s, and the store is generic over it. The federation
-([`federation.md`](federation.md)) is its first fold.
+A design, built stage by stage ([`federation.md`](federation.md), Stages): so far, the
+store held in memory, with a fold made for its tests (`federation::store`). The store
+holds events. Each event is named by the hash of its bytes and names the events it
+builds on; it is judged where it was written, at that history, so every node judges it
+alike; and the events a node holds read as one state. The store starts from a
+checkpoint, the state at some heads written down, and holds what came after it; moving
+to a later checkpoint, a node forgets what matters no more, so that it holds what is
+relevant and nothing else. What the events are, how one is judged, what they read as and
+when the store moves to a checkpoint is a **fold**'s, and the store is generic over it.
+The federation ([`federation.md`](federation.md)) is its first fold.
The store asks nothing of what carries its events. It is built first inside a swarm's
Automerge document (On Automerge): continuum's sync, transports, saving and remakes