Author SHA1 Message Date
clawbot 4c397786e6 Rewrite README.md sentence by sentence (closes #190)
check / check (push) Waiting to run
README.md is rewritten from scratch against the rules on issue 190 and
checked statement by statement against the code on next. It leads with
what the program is and how to use it, puts every endpoint, command,
numeric reply, mode and setting in reference sections, and ends with
development and testing. Where the old text disagreed with the code,
the code decides; the PR body lists each case. The hashcash examples
are real 20-bit stamps. REPO_POLICIES.md and CONVENTIONS.md are copies
of shared documents and are untouched.

Model: fable-5-1
2026-10-27 20:50:30 +00:00
clawbot 83a1585ddc Rewrite schema/README.md sentence by sentence
check / check (push) Waiting to run
Rewrite the description of the JSON Schema files from scratch, without
tables. Describe the fields of a message as the HTTP API sends them:
the reply name in `command` and its number in `code`. Drop the
federation section, which describes nothing the server does. List each
place where a schema file disagrees with the HTTP API, so that a reader
is not misled. The files themselves are unchanged.

Part of #190.

Model: fable-5-1 (writing); opus-5-5 (rework)
2026-10-27 16:09:17 +01:00
2 changed files with 1746 additions and 3205 deletions
+1743 -3202
View File
File diff suppressed because it is too large Load Diff
+3 -3
View File
@@ -43,9 +43,9 @@ IRC: :alice!alice@* PRIVMSG #general :hello world
JSON: {"command": "PRIVMSG", "from": "alice", "to": "#general", "body": ["hello world"]}
```
A numeric reply has its name in `command` and its number in `code`. This `353`
reply lists the members of `#general`. The JSON again leaves out `id`, `ts` and
`meta`:
In the JSON, a numeric reply has its name in `command` and its number in `code`.
This `353` reply lists the members of `#general`. The JSON again leaves out
`id`, `ts` and `meta`:
```
{"command": "RPL_NAMREPLY", "code": 353, "from": "neoirc", "to": "alice",