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/components/shared/Avatar.tsx

@@ -1,5 +1,6 @@
 /**
- * A user's avatar, or their initial.
+ * Renders a user's avatar, or their initial, wherever a user is named: cards,
+ * comments, chat, profiles and mention suggestions.
  *
  * @module
  */
@@ -8,24 +9,26 @@ import { useContext, useState } from "react";
 import { API_URL } from "../../config/api.ts";
 import { AvatarOverrideContext } from "../../contexts/ws/AvatarOverrideContext.ts";
 
-/** The props of {@link Avatar}. */
+/**
+ * Passed to {@link Avatar} from whatever data the caller has on the user, which
+ * may be stale: a live override from `AvatarOverrideContext` wins over
+ * `hasAvatar` and `version`.
+ */
 export interface AvatarProps {
-  /** The user's id. */
   userId: string;
-  /** The user's name, for the alt text and the initial. */
   username: string;
-  /** Whether they have an avatar, as the surrounding data says. */
   hasAvatar: boolean;
-  /** The side, in px; 36 by default. */
+  /** Sets the side, in pixels. */
   size?: number;
-  /** Cache-busts the avatar URL. */
+  /** Added to the URL so that a changed avatar isn't served from cache. */
   version?: number;
 }
 
 /**
- * Renders a user's avatar, or their initial when they have none or it fails to
- * load. A live `user_updated` override (avatar add/remove/change) wins over the
- * possibly-stale props the surrounding list was rendered with.
+ * Renders the image from `GET /api/avatars/:userId`, or the user's initial
+ * when they have none or it fails to load. An avatar added, changed or removed
+ * since the caller's data was fetched shows at once, through the
+ * `user_updated` messages that `WSProvider` puts in `AvatarOverrideContext`.
  */
 export function Avatar(
   { userId, username, hasAvatar, size = 36, version }: AvatarProps,
@@ -33,14 +36,12 @@ export function Avatar(
   const [imgFailed, setImgFailed] = useState(false);
   const sizeStyle = { width: size, height: size };
 
-  // A live `user_updated` override (avatar add/remove/change) wins over the
-  // possibly-stale props the surrounding list was rendered with.
   const override = useContext(AvatarOverrideContext)[userId];
   const effectiveHasAvatar = override ? override.hasAvatar : hasAvatar;
   const effectiveVersion = override ? override.version : version;
 
-  // A new image (different version/presence) is a fresh thing to try — clear
-  // any prior load failure during render rather than in an effect.
+  // A new image deserves a new try, so a past load failure is cleared. It is
+  // done during render, since an effect would show the initial for a frame.
   const imgKey = `${effectiveHasAvatar}:${effectiveVersion ?? ""}`;
   const [prevImgKey, setPrevImgKey] = useState(imgKey);
   if (prevImgKey !== imgKey) {