diff options
| author | tv <tv@krebsco.de> | 2026-11-18 12:41:10 +0000 |
|---|---|---|
| committer | tv <tv@krebsco.de> | 2026-11-18 13:42:58 +0100 |
| commit | 0bfe07af92a775b0e896e0fc5a989a1d9b65f7b3 (patch) | |
| tree | cd8d576ac13160163a2cee508cf985ef183b3a01 /docs/guides | |
| parent | b0f0e1a9edb08b324df2ec5e97d15e7089349fdb (diff) | |
docs: references to a section of the same document linked to it
Where a document names one of its own sections in parentheses ("(What
counts, 5)", "(Joining, below)"), the name links to the section by its
GitHub-style ID; paragraphs that grew past the width are wrapped anew,
links and code kept on one line each. References to another document's
sections stay as they are.
Diffstat (limited to 'docs/guides')
| -rw-r--r-- | docs/guides/federation/checkpoints.md | 2 | ||||
| -rw-r--r-- | docs/guides/federation/proposing-and-voting.md | 5 | ||||
| -rw-r--r-- | docs/guides/federation/running-a-node.md | 2 | ||||
| -rw-r--r-- | docs/guides/federation/writing-and-reading.md | 2 |
4 files changed, 6 insertions, 5 deletions
diff --git a/docs/guides/federation/checkpoints.md b/docs/guides/federation/checkpoints.md index 0ff26fe..23f0e9c 100644 --- a/docs/guides/federation/checkpoints.md +++ b/docs/guides/federation/checkpoints.md @@ -17,7 +17,7 @@ their votes. What it loses: what counted no more before the heads, so a key added back or a place given back brings back nothing signed before them; votes on versions behind it, so a party that voted twice there shows only in the votes the parties' clients kept; and what -isn't above the heads, which its party signs again (After a move, below). +isn't above the heads, which its party signs again ([After a move](#after-a-move), below). ## Proposing one diff --git a/docs/guides/federation/proposing-and-voting.md b/docs/guides/federation/proposing-and-voting.md index e342b5b..91da019 100644 --- a/docs/guides/federation/proposing-and-voting.md +++ b/docs/guides/federation/proposing-and-voting.md @@ -51,8 +51,9 @@ continuum-party --node http://tv:secret@localhost:3000 --key tv.key --record tv. # proposal 8d02… ``` -With `--yes`, the client votes `true` on it too, as `vote 8d02… yes` does (Voting, -below): a party whose node votes for it by itself votes through that node instead. +With `--yes`, the client votes `true` on it too, as `vote 8d02… yes` does +([Voting](#voting), below): a party whose node votes for it by itself votes through that +node instead. The client proposes only a version it would back: one changing the current one as a version must (its `number`, `changes`, and each `since`), whose checkpoint, where it names diff --git a/docs/guides/federation/running-a-node.md b/docs/guides/federation/running-a-node.md index a423376..b303fab 100644 --- a/docs/guides/federation/running-a-node.md +++ b/docs/guides/federation/running-a-node.md @@ -23,7 +23,7 @@ what its API lets in, and joining. whenever it starts: without the file, it may then take what it refused. Keep it beside the document file; one that doesn't read stops the node from starting. * `--store-checkpoint ID`: a checkpoint the node reads its store from whenever it starts, - instead of from the document's checkpoint, by its ID (Joining, below). + instead of from the document's checkpoint, by its ID ([Joining](#joining), below). * `--store-neighbour-parties NAME,…`: parties among whose members, with its own party's, the node keeps some of its neighbours. * `--store-vote-key PATH` and the options with it: the node votes and proposes for its diff --git a/docs/guides/federation/writing-and-reading.md b/docs/guides/federation/writing-and-reading.md index a9e0c5a..0a04773 100644 --- a/docs/guides/federation/writing-and-reading.md +++ b/docs/guides/federation/writing-and-reading.md @@ -68,7 +68,7 @@ A node refuses what every node refuses, judged at its history, and says why (`42 the federation spells one, or past its sizes. * `it builds on …, refused` (`builtOn`): an event it builds on is refused. * `it isn't above the checkpoint's heads` (`notAbove`): signed on heads a move to a - checkpoint left behind (After a move, below). + checkpoint left behind ([After a move](#after-a-move), below). And some by what the node took before (`own`), or as its operator had it drop them (`dropped`): those are the node's alone ([`running-a-node.md`](running-a-node.md)). |
