From 3e7c7eba8e512df852da38a6b9ddd8467ec4d4e7 Mon Sep 17 00:00:00 2001 From: Christophe Besson Date: Sat, 19 Sep 2026 01:49:11 +0200 Subject: docs: add a quickstart and a user guide MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit 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 --- CLAUDE.md | 8 ++++++++ 1 file changed, 8 insertions(+) (limited to 'CLAUDE.md') diff --git a/CLAUDE.md b/CLAUDE.md index 1f837eb..540bd8f 100644 --- a/CLAUDE.md +++ b/CLAUDE.md @@ -13,6 +13,14 @@ optional hub feature and are off on the reference deployment. `docs/` is either an operational guide, or a superseded document kept for its cross-references and carrying a banner that says so. +**`docs/QUICKSTART.md` and `docs/USERGUIDE.md` are the user documentation** — +written for somebody who is not a developer, Linux and the browser only. They +name CLI verbs, default values, setting names and interface labels, so a change +to any of those is a change to them: the previous user guide was retired +because it had drifted past the point where a reader could tell which half was +still true. What keeps them honest is that they state what is *not* built as +readily as what is (§15.2, §15.3); a feature that lands deletes its line there. + ## Repository structure ``` -- cgit v1.2.3