v3: shared/ is documented like api/ — deno doc --lint over api/ and shared/ goes from 385 errors to none — every module of shared/ opens with a /** … @module */ block; every export and every field of an exported interface has JSDoc, each request body naming the endpoint that takes it and each response its endpoint; the // comments that described declarations (the mention pattern, the permission union and table, four socket messages, the error message's optimistic-action context) are /** */ now, and the socket protocol's heading comment, which sat on no declaration, is its module doc. The lint wanted explicit types on MENTION_RE and DUMP_MAX_FILE_SIZE_BYTES. Along the way: the chat edit is allowed to moderators too, which the new ChatEditMessage doc says; UpdateUserRequest says that PATCH /api/users/me takes only its description and email; playlist-service's reorderPlaylist @throws is rewrapped. mod.ts and the README no longer call shared/ undocumented. No behaviour changes; 205 backend tests pass.

Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>

shared/search.ts

@@ -1,10 +1,20 @@
+/**
+ * What a search answers.
+ *
+ * @module
+ */
+
 import type { PaginatedData } from "./api.ts";
 import type { Dump } from "./dump.ts";
 import type { Playlist } from "./playlist.ts";
 import type { PublicUser } from "./user.ts";
 
+/** `GET /api/search`: what matches the query, in each kind. */
 export interface SearchResults {
+  /** A page of the matching dumps, with their total. */
   dumps: PaginatedData<Dump>;
+  /** The matching users. */
   users: PublicUser[];
+  /** The matching playlists. */
   playlists: Playlist[];
 }