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>

shared/validation.ts

@@ -1,39 +1,35 @@
 /**
- * The limits on what users submit, one set for the server that enforces them
- * and the forms that check them before sending.
+ * Holds the limits on what users submit, shared so that the forms check the
+ * same limits the server enforces.
  *
  * @module
  */
 
-/** Limits the server enforces and the forms check before sending. */
+/**
+ * Read by the validators and services, which refuse what breaks a limit, and
+ * by the forms, which say so before sending. Lengths are JavaScript string
+ * lengths, so an emoji may count for two. The category limits are checked on
+ * the server only.
+ */
 export const VALIDATION = {
-  /** Shortest username, in characters. */
   USERNAME_MIN: 1,
-  /** Longest username. */
   USERNAME_MAX: 32,
-  /** Shortest password. */
   PASSWORD_MIN: 8,
-  /** Longest password. */
   PASSWORD_MAX: 128,
-  /** Longest dump title. */
   DUMP_TITLE_MAX: 200,
-  /** Longest dump description. */
+  /** Applies to a dump's note, which the API calls its comment. */
   DUMP_COMMENT_MAX: 5000,
-  /** Longest playlist title. */
   PLAYLIST_TITLE_MAX: 100,
-  /** Longest playlist description. */
   PLAYLIST_DESCRIPTION_MAX: 2000,
-  /** Longest comment. */
   COMMENT_BODY_MAX: 5000,
-  /** Longest profile description. */
   USER_DESCRIPTION_MAX: 2000,
-  /** Longest category name. */
   CATEGORY_NAME_MAX: 50,
-  /** Longest category slug. */
   CATEGORY_SLUG_MAX: 50,
-  /** Longest chat message. */
   CHAT_MESSAGE_MAX: 2000,
 } as const;
 
-/** Largest file a file dump may hold, in bytes (50 MB). */
+/**
+ * The largest file a file dump may hold, in bytes. dump-service refuses a
+ * bigger one, and the create form before uploading it.
+ */
 export const DUMP_MAX_FILE_SIZE_BYTES: number = 50 * 1024 * 1024;