a1b89670c0
Backend (9): document, person, tag, user, geschichte, notification, ocr, audit, dashboard. Frontend (8): document, person, tag, user, geschichte, notification, ocr, shared. OCR service (1): ocr-service/README.md. Each README covers: what the domain owns, explicit non-ownership, public surface (verified by grep against the codebase), internal layout, and cross-domain dependencies. Closes #400 Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>
3.3 KiB
3.3 KiB
shared (frontend)
Cross-domain utilities and UI primitives. Any file here is consumed by two or more domain folders and has no domain identity of its own.
Admission criteria (what belongs here)
A file belongs in shared/ if it meets all three conditions:
- No domain identity — it does not represent a
Document,Person,Tag, etc. - Consumed by ≥ 2 domain folders — or is framework infrastructure that every domain depends on.
- Generic — could work in a different SvelteKit project with zero business-logic changes.
If any condition fails, the file belongs in the domain folder of its primary consumer.
What this folder owns
| Sub-folder / file | Purpose |
|---|---|
api.server.ts |
Typed openapi-fetch client factory — the standard entry point for all backend API calls in server-side load functions and actions |
errors.ts |
Mirror of the backend ErrorCode enum + getErrorMessage() → Paraglide i18n key mapping |
types.ts |
Cross-domain TypeScript interfaces |
utils.ts |
Pure utility functions (date formatting, sorting, debounce) |
relativeTime.ts |
Human-relative time formatting ("2 days ago") |
primitives/ |
Generic UI components: BackButton.svelte, form inputs, pagination, layout shells |
discussion/ |
Comment/mention editor shared by document/ and geschichte/ |
dashboard/ |
Family Pulse widget and recent-activity components assembled in the / route |
hooks/ |
Svelte 5 reactive hooks: useTypeahead, useUnsavedWarning |
services/ |
Generic client-side service helpers |
actions/ |
Shared SvelteKit form action utilities |
server/ |
Server-only shared utilities (load function helpers) |
help/ |
Coach marks and empty-state components used across multiple domains |
What does NOT belong here
- Components owned by one domain — move to that domain's folder.
- Domain-specific business logic — even if shared, it belongs in the owning domain's public surface.
Adding to shared/
If you need to add a file here, confirm it meets all three admission criteria. If it's domain-adjacent, check whether the owning domain should export it as part of its public surface instead.