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/DumpEdit.tsx

@@ -1,5 +1,5 @@
 /**
- * The dump editor.
+ * The page where a dump's poster, or a moderator, edits or deletes it.
  *
  * @module
  */
@@ -44,16 +44,18 @@ import { TextField } from "../components/form/TextField.tsx";
 import { useApiForm } from "../hooks/form/useApiForm.ts";
 import { VisibilityToggle } from "../components/form/SegmentedField.tsx";
 
-/** The page's state: loading, failed, or loaded with the dump. */
 type DumpEditState =
   | { status: "loading" }
   | { status: "error"; error: string }
   | { status: "loaded"; dump: Dump };
 
 /**
- * Renders `/dumps/:selectedDump/edit`, for a signed-in user: the dump's title,
- * link or file, note, visibility and thumbnail to edit, its preview to refresh,
- * and a delete button.
+ * Renders `/dumps/:selectedDump/edit`, for a signed-in user. The page itself
+ * doesn't check that the user may edit the dump: `Dump` links here only for
+ * its poster and moderators, and the API refuses anyone else's changes. The
+ * dump comes from `GET /api/dumps/:dumpId`. The thumbnail, the preview refresh
+ * and the deletion apply at once, and the form's other fields on "Save", which
+ * goes back to the dump's page. A deletion goes to the index.
  */
 export function DumpEdit(): React.JSX.Element {
   const { selectedDump } = useParams();
@@ -171,6 +173,8 @@ export function DumpEdit(): React.JSX.Element {
       setDeleteError(friendlyFetchError(err));
       return;
     }
+    // Meant for Index, to hide the dump before `dump_deleted` arrives, but the
+    // redirect from `/` doesn't pass the state on.
     navigate("/", { state: { deletedDumpId: state.dump.id } });
   };
 
@@ -275,6 +279,8 @@ export function DumpEdit(): React.JSX.Element {
           onThumbnailChange={handleThumbnailChange}
           onThumbnailReset={handleThumbnailReset}
           onRequestDelete={() => setConfirmDelete(true)}
+          // Passed along so the dump's page shows the saved dump without
+          // refetching it.
           onSaved={(updated) =>
             navigate(dumpUrl(updated), { state: { dump: updated } })}
         />
@@ -291,7 +297,8 @@ export function DumpEdit(): React.JSX.Element {
   );
 }
 
-/** The props of {@link DumpEditForm}. */
+// The thumbnail and deletion are handled by DumpEdit, which applies them at
+// once; the form only reports them.
 interface DumpEditFormProps {
   dump: Dump;
   preview: React.ReactNode;
@@ -305,7 +312,6 @@ interface DumpEditFormProps {
   onSaved: (dump: Dump) => void;
 }
 
-/** The form's fields. */
 interface EditValues {
   title: string;
   url: string;
@@ -314,7 +320,11 @@ interface EditValues {
   newFile: File | null;
 }
 
-/** Renders the dump's edit form. */
+/**
+ * Renders the edit form of `dump`, which saves through
+ * `PUT /api/dumps/:dumpId`, or `PUT /api/dumps/:dumpId/file` when a new file
+ * is attached. `DumpEdit` keys it by dump, so the fields reset for another.
+ */
 function DumpEditForm({
   dump,
   preview,
@@ -348,7 +358,7 @@ function DumpEditForm({
     },
   });
 
-  // Metadata-extracted title for URL dumps; the source for "Reset to default".
+  // The title scraped from the link, which "Reset to default" puts back.
   const metaTitle = dump.richContent?.title?.trim() ?? "";
   const currentTitle = form.watch("title");
 
@@ -404,8 +414,8 @@ function DumpEditForm({
     <FormProvider {...form}>
       <form className="form dump-edit-form" onSubmit={onSubmit}>
         {
-          /* Left: the dumped thing itself — what it looks like and where it
-            comes from. Right: how it's presented and shared. */
+          /* The source panel holds what was dumped, the details panel how it
+            is presented and who sees it. */
         }
         <div className="dump-edit-panel dump-edit-panel--source">
           {preview}