marcel/familienarchiv
1
0
Fork 0
Code Issues 126 Pull Requests 1 Actions Packages Projects Releases Wiki Activity

docs(legibility): fix two method signature blockers in domain READMEs

Browse Source 
- 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 <noreply@anthropic.com>
This commit is contained in:
Marcel
2026-05-05 23:18:30 +02:00
committed by marcel
parent a1b89670c0
commit 9b2ed48689
2 changed files with 2 additions and 2 deletions
Download Patch File Download Diff File Expand all files Collapse all files

2
backend/src/main/java/org/raddatz/familienarchiv/document/README.md
View File

@@ -25,7 +25,7 @@ Features: document CRUD, file upload/download, full-text search, bulk editing, t
| `findWeeklyStats()` | dashboard | Activity data for Family Pulse widget | | `findWeeklyStats()` | dashboard | Activity data for Family Pulse widget |
| `count()` | dashboard | Total document count for stats | | `count()` | dashboard | Total document count for stats |
| `addTrainingLabel(...)` | ocr | Attach a confirmed sender label to a document | | `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 ## Internal layout

2
backend/src/main/java/org/raddatz/familienarchiv/notification/README.md
View File

@@ -16,7 +16,7 @@ Features: create and deliver notifications, unread count, mark-read, SSE real-ti
| Method | Consumer | Purpose | | 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 | | `notifyReply(parentComment, reply)` | document (comment) | Push reply notification to the thread author |
| `countUnread(userId)` | user session | Unread badge count in the nav bar | | `countUnread(userId)` | user session | Unread badge count in the nav bar |
| `getNotifications(userId)` | dashboard / activity | Notification list for bell dropdown | | `getNotifications(userId)` | dashboard / activity | Notification list for bell dropdown |