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/pages/UserLogin.tsx

@@ -1,5 +1,5 @@
 /**
- * The sign-in page.
+ * Renders the sign-in page, which also requests password reset links.
  *
  * @module
  */
@@ -24,20 +24,18 @@ import { SubmitButton } from "../components/form/SubmitButton.tsx";
 import { TextField } from "../components/form/TextField.tsx";
 import { useApiForm } from "../hooks/form/useApiForm.ts";
 
-/** The sign-in form's fields. */
 interface LoginValues {
   username: string;
   password: string;
 }
 
-/** The reset request form's fields. */
 interface ResetValues {
   email: string;
 }
 
 /**
- * Renders `/login`, for the signed out: the sign-in form, and a way to ask for
- * a password reset link.
+ * Renders `/login`, for the signed out. A sign-in lands on `/`, and "Forgot
+ * password?" unfolds the reset request form below.
  */
 export function UserLogin(): React.JSX.Element {
   useDocumentTitle(t`Log in`);
@@ -111,16 +109,16 @@ export function UserLogin(): React.JSX.Element {
 }
 
 /**
- * Renders the form that emails a password reset link. The answer is the same
- * whether or not the address is known.
+ * Renders the form that asks the server to email a password reset link, which
+ * leads to `/reset-password`.
  */
 function ResetRequestPanel() {
   const [sent, setSent] = useState(false);
   const form = useApiForm<ResetValues>({ defaultValues: { email: "" } });
 
   const onSubmit = form.submit(async ({ email }) => {
-    // The answer is the same whether or not the address is known; only a
-    // server that failed to take the request is worth reporting.
+    // The server answers 200 whether or not the address is known, so as not
+    // to reveal which ones are. An error here means it failed.
     await expectOk(
       await fetch(`${API_URL}/api/users/request-password-reset`, {
         method: "POST",