v3: comments say what the code can't — the documentation pass wanted JSDoc on every export and every field of an exported interface, which filled the code with restatements ("The dump.", "Whether it is loading.", "The props of X.", "Renders the X.") and module docs that told a reader nothing ("The hot and new feeds, and the props every main feed of the index takes."); some were wrong as well as vague. Every comment in api/, shared/ and src/ is rewritten under one rule, now stated in the README's "Comments" section: every module and export still has a JSDoc, and it gives context (who uses it and where), usage (what a caller must know: a precondition, what it leaves to the caller, a side effect) or its place in the chain (where its input comes from, where its output goes); a field, parameter, private function or local gets one only when it adds to its parent's, and context about a whole type goes on the type; a type's doc is phrased from the value's side ("Returned to Y by X when Z", "Passed to Y by X"); full sentences, as short as they can be, no label-colon-list; // goes wherever the code isn't obvious and says why, and the section banners and narration go. Every claim was checked against the code, which turned up some forty comments that were wrong: DumpCard's claimed it was only used by the hot and new feeds, the WebSocket welcome claimed to be a socket's first message (presence comes first), UpdateUserRequest said null removes a description (it keeps it), deletedDumpIds leaves out that it also holds dumps made private, THEME_COLOR claimed to mirror index.html's, and the like. The routers' JSDoc now says where they are mounted and what becomes of a thrown APIException. doc-lint.ts lets a field without a doc through; a module or export without one still fails. No code changes; 204 backend and 628 frontend tests pass, and doc:lint, deno check, deno lint and tsc are clean.

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

api/lib/static.ts

@@ -1,6 +1,7 @@
 /**
- * Serving the built frontend: static files, and `index.html` with its
- * placeholders filled for every client-side route.
+ * Serves the built frontend, as its static files and, for every client-side
+ * route, `index.html` with its placeholders filled. main.ts installs it after
+ * the routers.
  *
  * @module
  */
@@ -8,30 +9,31 @@
 import { Context, Next, send } from "@oak/oak";
 import { loadIndexHtml } from "./index-html.ts";
 
-/** Answers with the filled `index.html` of `root`, always revalidated. */
 async function serveIndexHtml(
   context: Context<Record<string, object>>,
   root: string,
 ) {
   const html = await loadIndexHtml(root);
   context.response.type = "text/html";
-  // Always revalidated: it names the hashed chunks of the current build.
+  // It names the hashed chunks of the current build, so it is always
+  // revalidated.
   context.response.headers.set("Cache-Control", "no-cache");
   context.response.body = html;
 }
 
 /**
- * Build output whose URL changes whenever its content does: Vite's hashed
- * chunks, and the emoji data under its package version (see vite.config.ts).
+ * Prefixes the build output whose URL changes whenever its content does, which
+ * are Vite's hashed chunks and the emoji data under its package version (see
+ * vite.config.ts).
  */
 const IMMUTABLE_PREFIXES = ["/assets/", "/emojibase/"];
 const ONE_YEAR_MS = 365 * 24 * 60 * 60 * 1000;
 
 /**
- * Returns a middleware serving static files from the first of `staticPaths`
- * that has them, and `index.html` from the first for any other path so
- * client-side routes load on direct navigation. Hashed build output is cached
- * for a year, and a missing chunk is a 404.
+ * Returns the middleware that serves a static file from the first of
+ * `staticPaths` that has it, and `index.html` of the first for any other path.
+ * Hashed build output is cached for a year, and a missing chunk is a 404.
+ * main.ts passes dist/ then public/.
  */
 export function routeStaticFilesFrom(
   staticPaths: string[],
@@ -39,7 +41,6 @@ export function routeStaticFilesFrom(
   return async (context: Context<Record<string, object>>, next: Next) => {
     const pathname = context.request.url.pathname;
 
-    // Serve index.html with runtime placeholder replacement
     if (pathname === "/" || pathname === "/index.html") {
       await serveIndexHtml(context, staticPaths[0]);
       return;
@@ -53,7 +54,8 @@ export function routeStaticFilesFrom(
     const compress = context.request.headers.has("accept-encoding");
     for (const path of staticPaths) {
       try {
-        // send() picks a prebuilt .br or .gz sibling when the browser accepts it.
+        // send() picks a prebuilt .br or .gz sibling when the browser accepts
+        // it.
         await send(context, pathname, {
           root: path,
           brotli: compress,
@@ -74,7 +76,7 @@ export function routeStaticFilesFrom(
       return;
     }
 
-    // SPA fallback: serve index.html so client-side routes work on direct navigation
+    // Any other path is a client-side route, opened directly or reloaded.
     await serveIndexHtml(context, staticPaths[0]);
     await next();
   };