diff options
| author | Christophe Besson <cbesson@gmail.com> | 2026-09-19 01:49:11 +0200 |
|---|---|---|
| committer | Christophe Besson <cbesson@gmail.com> | 2026-09-19 01:49:56 +0200 |
| commit | 3e7c7eba8e512df852da38a6b9ddd8467ec4d4e7 (patch) | |
| tree | ac529c48cb40cb4c795a61345365fca07f47e965 /docs/MESHBAY_DESIGN.md | |
| parent | c2c49182e6d4f1f1ef3ed3ba5e8699912f9a27bd (diff) | |
| download | meshbay-3e7c7eba8e512df852da38a6b9ddd8467ec4d4e7.tar.gz | |
docs: add a quickstart and a user guide
QUICKSTART takes one Linux machine from downloaded packages to a working
group with a second member. USERGUIDE covers using a group and running a
node, for a reader who is not a developer. Windows stays in
PACKAGING-GUIDE.md.
Both are written from the code — the CLI, ops.py, the systemd units and
the interface catalogue — rather than from the specification, and they
state what is not built as readily as what is.
Co-Authored-By: Claude Opus 5 <noreply@anthropic.com>
Diffstat (limited to 'docs/MESHBAY_DESIGN.md')
| -rw-r--r-- | docs/MESHBAY_DESIGN.md | 15 |
1 files changed, 11 insertions, 4 deletions
diff --git a/docs/MESHBAY_DESIGN.md b/docs/MESHBAY_DESIGN.md index dcfc77b..551c0ed 100644 --- a/docs/MESHBAY_DESIGN.md +++ b/docs/MESHBAY_DESIGN.md @@ -30,6 +30,8 @@ | Read | For | |---|---| | **this document** | the architecture, the trust model, and the reason each decision is what it is | +| `QUICKSTART.md` | one machine to a working group, for somebody who has installed nothing | +| `USERGUIDE.md` | using a group and running a node, for the person who does either | | `MESHBAY_NODE_PROTOCOL.md` | the MNP wire format, message by message | | `transfers-v1.md` | the transfer system's failure-mode analysis, kept because a synthesis cannot carry "every way a slot can be lost" | | `playlists.md` | the playlist design and its interface in full, with what building it corrected (§9.10) | @@ -38,10 +40,15 @@ | `PACKAGING-GUIDE.md`, `HTTPS.md`, `MAIL-SERVER.md`, `windows-build.md` | installation and server operations | | `CLAUDE.md` | project conventions and the engineering lessons that govern how changes are made | -**There is no user guide.** The one that existed described the system before -per-node identity, named roots and the sealed wire, and was retired rather than -repaired — a document a reader cannot tell the sound parts of is worse than none. -Writing a new one starts here. +**The user documentation is `QUICKSTART.md` and `USERGUIDE.md`** (written +2026-09-18). The guide that preceded them described the system before per-node +identity, named roots and the sealed wire, and was retired rather than repaired +— a document a reader cannot tell the sound parts of is worse than none. The +replacements are written from this document and from the code, address a reader +who is not a developer, and cover Linux and the browser; Windows stays in +`PACKAGING-GUIDE.md`. **They state what is not built as readily as what is** +(§15.2, §15.3), which is what keeps them from drifting into the same condition +as the one they replace. ### 0.2 Reference labels |