Files
faunosteo/docs/ADDING-A-SPECIES.md
T
ZenQuality a115e785a7 chore: initial scaffold
Generated by /init-project. React 19 + TS strict + Vite 6 + Tailwind 4 +
shadcn/ui + motion + pdf-lib + Zod + Zustand + react-router 7. Empty
skeleton, no business logic. Docker multi-stage + nginx + Traefik labels
commented. AGPL-3.0-or-later.
2026-05-17 06:43:11 +02:00

22 lines
1.5 KiB
Markdown
Raw Blame History

This file contains ambiguous Unicode characters
This file contains Unicode characters that might be confused with other characters. If you think that this is intentional, you can safely ignore this warning. Use the Escape button to reveal them.
# Ajouter une espèce
Le code est conçu pour rendre triviale l'ajout d'une nouvelle espèce. Trois fichiers + trois SVG.
## Étapes
1. **Créer le dossier** `src/species/<id>/` où `<id>` ∈ { chien, chat, equine, lapin, bovin, chevre, ane, mouton, porc, … }.
2. **Anatomie** — `src/species/<id>/anatomy.ts` exporte un `SpeciesAnatomy` (voir `src/species/types.ts`) :
- `id`, `label`, `vertebralFormula`
- `zones[]` (id, label, catégorie, vues où visible, sous-zones éventuelles)
- `svg` : chemins relatifs vers les 3 SVG (`lateral_left`, `lateral_right`, `dorsal`)
3. **Pathologies** — `src/species/<id>/pathologies.ts` exporte `PathologyEntry[]`.
Chaque entrée DOIT citer au moins une source clinique (Merck Veterinary Manual, IMAIOS,
PubMed, etc.). Voir `src/species/equine/README.md` pour la liste des sources de référence.
4. **Illustrations** — 3 SVG conformes à la convention (voir `ANATOMY-SVG-CONVENTION.md`) :
- `lateral_left.svg`, `lateral_right.svg`, `dorsal.svg`
- viewBox normalisé (1000×600 latéral, 1000×800 dorsal)
- Couche `#illustration` + couche `#zones` avec `data-zone="<zoneId>"` sur chaque path.
5. **Enregistrement** — dans `src/species/registry.ts`, importer puis `registerSpecies('<id>', { anatomy, pathologies })`.
Ou : laisser le chargement paresseux via `import('./<id>/index.ts')` (préféré pour le code-splitting).
6. **Test** — `tests/unit/species.<id>.test.ts` doit vérifier que le pack se charge et que la liste de zones est non vide.