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>

src/contexts/ws/AvatarOverrideContext.ts

@@ -1,5 +1,6 @@
 /**
- * The avatar override context: avatars changed live, provided by WSProvider.
+ * Declares the context through which `Avatar` learns of avatars changed since
+ * the page loaded. `WSProvider` fills it from `user_updated` messages.
  *
  * @module
  */
@@ -7,22 +8,22 @@
 import { createContext } from "react";
 
 /**
- * Live avatar state learned from `user_updated` WS events. Kept in its own
- * context (not WSContext) so that `Avatar` — rendered many times across feeds
- * and comment threads — only re-renders when an avatar actually changes, not on
- * every vote/comment/dump event.
+ * Set by `WSProvider` for a user whose profile changed, and read by `Avatar`,
+ * where it wins over the possibly stale props the page fetched.
  */
 export interface AvatarOverride {
-  /**
-   * Whether the user currently has an avatar, so a freshly added or removed
-   * avatar flips even when the surrounding list data is stale.
-   */
   hasAvatar: boolean;
-  /** Cache-busts the avatar URL (derived from the user's `updatedAt`). */
+  /**
+   * The user's `updatedAt` in ms, or the arrival time without one. It busts the
+   * cached image.
+   */
   version: number;
 }
 
-/** The avatar override context, keyed by user id. */
+/**
+ * Holds an {@link AvatarOverride} by user id. It is apart from `WSContext`, so
+ * the many avatars of a page don't re-render on every vote or comment.
+ */
 export const AvatarOverrideContext: React.Context<
   Record<string, AvatarOverride>
 > = createContext<