docs(chore): step 5 — annotation rendering contract, CLAUDE.md map and conventions, README, DEPLOY SHEET_BUNDLE, PDF format v3, spec §6 migration map, plan/changelog/strategy notes; BDR-038, LRN-043, TODO
This commit is contained in:
1 parent
ce2ec26112
commit
0476276a8f
19 files changed
+276
-112
No files matched your search
@@ -5,10 +5,11 @@ SVGs — click zones, build observations, export a self-contained PDF with the
|
||||
full report JSON embedded as a native PDF attachment. Re-importing that PDF
|
||||
restores the state for a follow-up.
|
||||
|
||||
Multi-species by design. MVP data set covers the **horse** (équin). Additional
|
||||
species — dog, cat, goat, cow, pig, rabbit, donkey, sheep — drop in by adding
|
||||
their SVG schematic + manifest + pathology file under `src/domain/species/`.
|
||||
See [`docs/ADDING-A-SPECIES.md`](docs/ADDING-A-SPECIES.md) for the recipe.
|
||||
Multi-species by design. The MVP ships the **horse** sheet: a canonical anatomical
|
||||
sheet document (drawing + annotations + findings catalog, `packages/domain`)
|
||||
generated and curated under `supabase/seed/anatomical-sheets/equine/`. Another
|
||||
species is another sheet document, no code change.
|
||||
See `docs/development/ANATOMICAL_SHEET_MODEL.md` §6 for how a sheet is produced.
|
||||
|
||||
Open to every praticien who wants to use it. No authentication, no backend,
|
||||
no central server in v1 — the PDF is the long-term record. Phase 2 will add
|
||||
@@ -19,20 +20,17 @@ contract.
|
||||
|
||||
## Features
|
||||
|
||||
- **Anatomy canvas** — inline SVG with clickable zones; hitbox+visible twin pattern; delegated click listener
|
||||
- **Anatomy canvas** — inline SVG drawing with markers rendered from the sheet document (hitbox + visible twin, delegated click listener)
|
||||
- **Observation builder** — group zones into clinical observations with severity and free-text notes
|
||||
- **Hierarchical findings tree** — per-zone picker with breadcrumb drill-down through the expert-authored catalog (26 zones for the horse), vet-referral badges on sensitive leaves, scope-disclaimer modal once per session
|
||||
- **Vertebra picker** — region tabs (C/T/L/S/Cd) with multi-select chip grid for precise vertebral notation
|
||||
- **Detail popups** — click a zone (e.g. head) to open a secondary SVG with finer-grained zones
|
||||
- **PDF export** — A4 portrait with rasterized anatomy SVGs (native browser `Image`/`canvas` pipeline), structured observations, and the full report JSON as a native PDF attachment
|
||||
- **Detail views** — click the head trigger to open the head view (a crop of the same drawing, or a view's own asset)
|
||||
- **PDF export** — A4 portrait with rasterized views, structured observations, and the full Report v3 JSON as a native PDF attachment; older v2 PDFs import through a generated migration map
|
||||
- **PDF re-import** — open a previously exported PDF to restore the session for a follow-up
|
||||
- **Bilingual UI** — full FR/EN interface with a one-click language switcher; default locale auto-detected from the browser, then persisted
|
||||
- **Configurable identity** — site name, brand, footer, tagline all come from env vars; nothing hardcoded
|
||||
- **Practitioner cache** — last-used practitioner block prefilled via localStorage
|
||||
- **Pathology editor** — standalone `pathology-editor.html` tool (no build step) for visually editing the species findings JSON via SVG zone selection; exports a downloadable JSON file
|
||||
- **Laterality** — left/right side selection on bilateral zones, reflected in badges and the PDF
|
||||
- **SVG anatomy editor** — in-app `/svg-editor` tool to annotate anatomy SVGs
|
||||
- **Welcome screen + editors page** — tabbed entry with a project SVG picker and an `/editors` listing
|
||||
- **Footer branding** — global footer (copyright, "Powered by ZenQuality", partner logo), on site + PDF
|
||||
|
||||
---
|
||||
@@ -101,9 +99,9 @@ For production deployment (VPS provisioning, firewall, TLS, nginx reverse proxy,
|
||||
## Documentation
|
||||
|
||||
- [CLAUDE.md](CLAUDE.md) — project conventions, stack reference, architecture overview
|
||||
- [docs/ANATOMY-SVG-CONVENTION.md](docs/ANATOMY-SVG-CONVENTION.md) — SVG data-* contract (source of truth)
|
||||
- [docs/ADDING-A-SPECIES.md](docs/ADDING-A-SPECIES.md) — guide for adding a second species post-MVP
|
||||
- [docs/PATHOLOGIES-FORMAT.md](docs/PATHOLOGIES-FORMAT.md) — findings catalog format + authoring guide
|
||||
- [docs/ANNOTATION-RENDERING.md](docs/ANNOTATION-RENDERING.md) — annotation layer contract (markers drawn from the sheet document)
|
||||
- [docs/development/ANATOMICAL_SHEET_MODEL.md](docs/development/ANATOMICAL_SHEET_MODEL.md) — canonical anatomical sheet document, curation pipeline, report migration map
|
||||
- [docs/development/STEP5_MIGRATION_ANALYSIS.md](docs/development/STEP5_MIGRATION_ANALYSIS.md) — how the application moved onto the canonical sheet (Report v3)
|
||||
- [docs/PDF-FORMAT.md](docs/PDF-FORMAT.md) — PDF page layout and attachment contract
|
||||
- [docs/development/SUPABASE.md](docs/development/SUPABASE.md) — local Supabase stack, migrations, RLS tests, generated types
|
||||
- [DEPLOY.md](DEPLOY.md) — production VPS deploy guide (Docker + nginx + TLS + hardening)
|
||||
@@ -117,25 +115,26 @@ For production deployment (VPS provisioning, firewall, TLS, nginx reverse proxy,
|
||||
```
|
||||
faunosteo/ pnpm workspace (see docs/development/WORKSPACE.md)
|
||||
├─ apps/app/ the private application (@faunosteo/app):
|
||||
├─ public/species/equine/ anatomy SVGs (Horse.svg, Horse_head.svg)
|
||||
├─ vite/sheet-bundle.ts Vite plugin bundling the reference sheet (SHEET_BUNDLE=draft|none)
|
||||
├─ src/app/ routes + ConfigProvider
|
||||
├─ src/config/ runtime env config resolution
|
||||
├─ src/domain/ Zod schemas + species registry + equine data
|
||||
├─ src/sheets/ SheetProvider (bundled implementation) + useSheet hook
|
||||
├─ src/services/ sheet index (lookups by id) + zone interaction service (pure)
|
||||
├─ src/i18n/ translation dicts (fr/en) + useT() hook
|
||||
├─ src/state/ Zustand store + locale store + localStorage cache
|
||||
├─ src/anatomy/ SVG parser + loader
|
||||
├─ src/state/ Zustand store (Report v3) + persistence adapter + locale store
|
||||
├─ src/anatomy/ drawing: sanitised asset + annotation layer → inline SVG per view
|
||||
├─ src/components/ UI primitives, canvas, observation, report
|
||||
├─ src/pdf/ export/import/attachment/fonts + renderers
|
||||
├─ src/lib/ id, dates, assert utilities
|
||||
├─ src/styles/ Tailwind v4 CSS + design tokens
|
||||
├─ tests/unit/ vitest tests (apps/app/tests, incl. characterisation suite)
|
||||
├─ packages/domain/ @faunosteo/domain: canonical anatomical sheet document (Zod) + integrity rules
|
||||
├─ tests/unit/ vitest tests on the bundled sheet (+ frozen v2 fixtures)
|
||||
├─ packages/domain/ @faunosteo/domain: canonical sheet document + report document (v3, v2 migration)
|
||||
├─ packages/anatomy/ @faunosteo/anatomy: legacy importer, curation pipeline, annotation-layer renderer
|
||||
├─ packages/supabase/ @faunosteo/supabase: typed client, generated types, PGlite SQL test harness
|
||||
├─ supabase/ CLI config, SQL migrations, local seed, pgTAP tests
|
||||
├─ supabase/ CLI config, SQL migrations, local seed (incl. the equine sheet), pgTAP tests
|
||||
├─ docker/ entrypoint.sh + nginx.conf
|
||||
├─ docs/ conventions + species guide + PDF spec
|
||||
├─ index.html SPA entry point
|
||||
└─ public/pathology-editor.html standalone pathology JSON editor (served as static file)
|
||||
├─ docs/ conventions, sheet model, PDF spec, development plan
|
||||
└─ index.html SPA entry point
|
||||
```
|
||||
|
||||
---
|
||||
@@ -146,16 +145,16 @@ v0.1.0 MVP — implementation complete.
|
||||
|
||||
- `pnpm typecheck` ✅
|
||||
- `pnpm lint` ✅
|
||||
- `pnpm test:run` ✅ — 271 tests across 39 files
|
||||
- `pnpm test:run` ✅ — 310 tests across the workspace (domain, anatomy, supabase, app)
|
||||
- `pnpm build` ✅
|
||||
|
||||
The first species data set ships with the real `Horse.svg` + `Horse_head.svg`
|
||||
anatomy sources at `public/species/equine/` and a full v2.0 findings catalog
|
||||
(26 zones, 792 nodes, 612 leaves, 41 vet-referral leaves) authored by the
|
||||
domain expert. Adding **dog, cat, goat, cow, pig, rabbit, donkey, sheep** is
|
||||
the same procedure: convention-compliant SVG + manifest + findings JSON. See
|
||||
[docs/ADDING-A-SPECIES.md](docs/ADDING-A-SPECIES.md) and
|
||||
[docs/PATHOLOGIES-FORMAT.md](docs/PATHOLOGIES-FORMAT.md).
|
||||
The first species ships as the equine anatomical sheet: the historical
|
||||
`Horse.svg`, `Horse_head.svg` and findings catalog (26 zones, 792 nodes)
|
||||
imported, then audited and curated (`supabase/seed/anatomical-sheets/equine/`,
|
||||
44 traced changes, 48 references). The application bundles that curated
|
||||
draft in development (`SHEET_BUNDLE=draft`); it is not medically validated and
|
||||
a production build carries no sheet unless asked. Another species is another
|
||||
sheet document produced the same way.
|
||||
|
||||
Manual QA checklist: `.claude/audits/MVP-QA.md` — walk it through `pnpm dev`
|
||||
before delivery.
|
||||
|
||||
Reference in new issue
Block a user