From 42b8f0c120286438a818c9b131feb921e6d1c9e7 Mon Sep 17 00:00:00 2001 From: Marcel Date: Tue, 5 May 2026 23:18:30 +0200 Subject: [PATCH] docs(legibility): fix two method signature blockers in domain READMEs - notification/README.md: notifyMentions second param is DocumentComment, not String contextUrl - document/README.md: transcription queue methods take int limit param Co-Authored-By: Claude Sonnet 4.6 --- .../src/main/java/org/raddatz/familienarchiv/document/README.md | 2 +- .../main/java/org/raddatz/familienarchiv/notification/README.md | 2 +- 2 files changed, 2 insertions(+), 2 deletions(-) diff --git a/backend/src/main/java/org/raddatz/familienarchiv/document/README.md b/backend/src/main/java/org/raddatz/familienarchiv/document/README.md index c6e830fc..8a67ec0d 100644 --- a/backend/src/main/java/org/raddatz/familienarchiv/document/README.md +++ b/backend/src/main/java/org/raddatz/familienarchiv/document/README.md @@ -25,7 +25,7 @@ Features: document CRUD, file upload/download, full-text search, bulk editing, t | `findWeeklyStats()` | dashboard | Activity data for Family Pulse widget | | `count()` | dashboard | Total document count for stats | | `addTrainingLabel(...)` | ocr | Attach a confirmed sender label to a document | -| `findSegmentationQueue()` / `findTranscriptionQueue()` / `findReadyToReadQueue()` | ocr | OCR pipeline queues | +| `findSegmentationQueue(int limit)` / `findTranscriptionQueue(int limit)` / `findReadyToReadQueue(int limit)` | ocr | OCR pipeline queues | ## Internal layout diff --git a/backend/src/main/java/org/raddatz/familienarchiv/notification/README.md b/backend/src/main/java/org/raddatz/familienarchiv/notification/README.md index 6a1ac9a3..840d6a61 100644 --- a/backend/src/main/java/org/raddatz/familienarchiv/notification/README.md +++ b/backend/src/main/java/org/raddatz/familienarchiv/notification/README.md @@ -16,7 +16,7 @@ Features: create and deliver notifications, unread count, mark-read, SSE real-ti | Method | Consumer | Purpose | |---|---|---| -| `notifyMentions(mentionedUserIds, contextUrl)` | document (comment) | Push mention notifications when a comment contains @mentions | +| `notifyMentions(mentionedUserIds, comment)` | document (comment) | Push mention notifications when a comment contains @mentions | | `notifyReply(parentComment, reply)` | document (comment) | Push reply notification to the thread author | | `countUnread(userId)` | user session | Unread badge count in the nav bar | | `getNotifications(userId)` | dashboard / activity | Notification list for bell dropdown |