v3: the backend is documented for deno doc, one way in every file, and the docs build and publish themselves — comments were in three shapes: file headers as // lines, as an untagged /** */ (which deno doc drops, only an @module block counts) or missing; 43 exports described by a // deno doc can't see, two JSDoc blocks sitting on the wrong declaration and one duplicated; endpoints commented in 5 of 18 route files, three ways, on router.get() calls no doc tool reads. The rule, applied to every non-test module of api/, migrations included: each opens with a /** … @module */ block; every export has JSDoc, and so does every field of an exported interface; a comment describing a declaration is /** */, // only notes code; functions open with a verb, everything else with a noun phrase; parameters are named in the prose, {@link} only for symbols in scope; whatever throws to its caller says so with @throws (for an APIException, the statuses and when); a router's JSDoc lists its endpoints, method and path, who may call it, what it does. deno doc --lint goes from 528 errors to none in api/ (shared/ keeps its 385; it is next). The lint also wanted explicit types on config.ts's settings and a few return types, JsonLdResult exported, and the routers typed Router. deno task doc builds the HTML reference into docs/ from every module of api/ and shared/ but the tests, deno task doc:lint lints it; the index page is the module doc of a root mod.ts (deno.json's exports), which introduces the backend, shared/ and the frontend to come and links every module, and mod.test.ts fails when one is missing. The docs workflow builds it on every push to main that touches them and publishes it to the gh-pages branch, like publish-assistant's. Two defects found along the way are fixed: a private playlist's cover was served to anyone who had its id or slug, and now needs its owner's media token, as private dump files do (playlistImageUrl adds it for private playlists only, so public cover URLs stay the same for everyone); og.ts and static.ts each filled index.html's placeholders, and now share lib/index-html.ts, so the OG middleware picks up a rebuilt index.html instead of keeping the first it read. The README states the documentation rule. 205 backend and 628 frontend tests pass.

Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>

README.md

@@ -158,6 +158,24 @@ place that fetches from other sites. Tests mirror the source one file per
 module, so the tests of `services/chat-service.ts` are in
 `test/services/chat-service.test.ts`.
 
+The backend is documented for `deno doc`, the same way in every file. Each
+module opens with a `/** … @module */` block saying what it is for. Every
+export has a JSDoc comment, and so does every field of an exported interface; a
+comment that describes a declaration is always `/** */`, and `//` is only for
+notes on the code inside. Functions open with a verb ("Returns…", "Checks…"),
+everything else with a noun phrase. Parameters are named in the prose, in
+backticks. `{@link}` points at symbols the file already has in scope. A
+function that can throw to its caller says so with `@throws`: for an
+`APIException`, the statuses and when. A router's JSDoc lists its endpoints, one
+line each: method and path, who may call it, what it does. `deno task doc`
+builds the HTML reference into `docs/` from every module of `api/` and
+`shared/` but the tests. Its index page is the module doc of `mod.ts` at the
+root, which introduces the repository's three parts and links every documented
+module (`mod.test.ts` checks it), and the `docs` workflow publishes it on every
+push to `main` that touches them. `deno task doc:lint` checks
+the rules the linter can see; `shared/` is not documented yet, so it still
+fails there.
+
 Each of the frontend's `components/`, `contexts/`, `hooks/` and `utils/` is
 split into the same domain folders — `auth`, `category`, `chat`, `comment`,
 `dump`, `editor`, `feed`, `form`, `layout`, `player`, `playlist`, `profile`,