diff options
Diffstat (limited to 'docs')
| -rw-r--r-- | docs/federation-tests.md | 10 | ||||
| -rw-r--r-- | docs/federation.md | 11 | ||||
| -rw-r--r-- | docs/store.md | 19 |
3 files changed, 21 insertions, 19 deletions
diff --git a/docs/federation-tests.md b/docs/federation-tests.md index 24c48f4..bfbbe7a 100644 --- a/docs/federation-tests.md +++ b/docs/federation-tests.md @@ -1,10 +1,10 @@ # Testing the store and the federation: a plan -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. +A plan, built stage by stage (By stage): so far, the store's tests and the federation's +fold's (stages 1 and 2). 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. ## What the tests rest on diff --git a/docs/federation.md b/docs/federation.md index 91ba4a2..8700e45 100644 --- a/docs/federation.md +++ b/docs/federation.md @@ -1,10 +1,11 @@ # Federation: a design -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 +A design, built stage by stage (Stages): so far, the store it builds on, held in memory, +and the federation as its fold (`federation::fold`), with the byte formats. 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 diff --git a/docs/store.md b/docs/store.md index d554a7a..12276b4 100644 --- a/docs/store.md +++ b/docs/store.md @@ -1,15 +1,16 @@ # The store: a design 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. +store held in memory (`federation::store`), with a fold made for its tests and the +federation's (`federation::fold`). 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 |
