docs: step 6 sync — README layout and docs list, WORKSPACE package rule, DEPLOY rollback note, CHANGELOG entry
This commit is contained in:
1 parent
ad48758f8c
commit
9e681232cf
4 files changed
+16
-6
No files matched your search
+2
-1
@@ -6,8 +6,9 @@ Versions follow [Semantic Versioning](https://semver.org/).
|
||||
|
||||
## [Unreleased]
|
||||
|
||||
### Added (SaaS migration, plan Steps 3–4)
|
||||
### Added (SaaS migration, plan Steps 3–6)
|
||||
|
||||
- **Autonomous PDF archives (Step 6)** — new `@faunosteo/pdf` engine (`packages/pdf`): the PDF is rendered from explicit inputs (report, sheet snapshot, branding, labels, locale, rasterizer, export date), with no network and no browser DOM; the attachment becomes a **report archive envelope v1** (`osteo-report.json`) carrying the Report v3, a lean but valid snapshot of the anatomical sheet (views, annotations, geometry, colours, relations, the finding paths used with their ancestor labels, the SVG drawing), the branding used at export and the FR/EN label dictionary, so an old bilan is reproduced identically after any catalog, wording or logo change. Layered reading keeps the report even when the wrapper or the snapshot is refused (closed reasons), v2 and bare v3 PDFs still import, a PDF whose attachment was stripped is recognised. Imported archives are kept in the session; a bilan reopened on a different sheet is rebased on a working copy with unresolved items flagged and their labels kept, and the import message says so. SVG assets go through an allowlist sanitiser with size and complexity caps checked at import and at export; a WinAnsi guard keeps any text from crashing the export. Pages unchanged (frozen by 39 goldens). `docs/PDF-FORMAT.md` written for real.
|
||||
- **Supabase foundation** — local stack (`supabase/config.toml`), migrations (schemas `private` / `audit`, `profiles`, platform roles with audited RPCs), pgTAP suite run on PGlite (`pnpm test:run`) and on the real stack (`pnpm db:test`), `@faunosteo/supabase` typed client + generated types. No UI change.
|
||||
- **Anatomical sheet model** — `@faunosteo/domain`: canonical sheet document (views tree, annotations with stable ids and explicit laterality, ordered vertebral regions, typed finding categories, explicit annotation → finding zone links, FR/EN labels) with integrity validation; tables `species`, `anatomical_sheets`, `anatomical_sheet_versions` (published rows immutable, one draft per sheet, deletion preconditions), `anatomical_sheet_assets`; lifecycle RPCs (create, draft, publish, deprecate, delete, fork with provenance, archive, assets) audited and under RLS. Spec: `docs/development/ANATOMICAL_SHEET_MODEL.md`.
|
||||
|
||||
|
||||
@@ -242,6 +242,12 @@ For zero-downtime updates, `docker compose up --build -d` rebuilds the
|
||||
image then recreates the container; the container restart is sub-second
|
||||
because nginx:alpine boots instantly. There is no warmup phase.
|
||||
|
||||
Rollback note (PDF archives, Step 6): PDFs exported by a Step 6 build carry
|
||||
a report archive envelope. A build older than Step 6 reads such a PDF as "no
|
||||
attachment"; a Step 6 build reads every older PDF (bare v2 and v3). Roll back
|
||||
only with that limit in mind and tell the practitioners which build produced
|
||||
their files.
|
||||
|
||||
---
|
||||
|
||||
## Data persistence
|
||||
|
||||
@@ -103,7 +103,8 @@ For production deployment (VPS provisioning, firewall, TLS, nginx reverse proxy,
|
||||
- [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/PDF-FORMAT.md](docs/PDF-FORMAT.md) — PDF pages, report archive envelope (snapshot, branding, labels), reading and limits
|
||||
- [docs/development/STEP6_PDF_ARCHIVE_ANALYSIS.md](docs/development/STEP6_PDF_ARCHIVE_ANALYSIS.md) — why and how the PDF became an autonomous archive (Step 6)
|
||||
- [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)
|
||||
- [CHANGELOG.md](CHANGELOG.md) — versioned release notes
|
||||
@@ -125,12 +126,13 @@ faunosteo/ pnpm workspace (see docs/development/WORKSPACE.md)
|
||||
├─ 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/pdf/ app side of the PDF: snapshot + branding + browser rasterizer → @faunosteo/pdf engine
|
||||
├─ src/lib/ id, dates, assert utilities
|
||||
├─ src/styles/ Tailwind v4 CSS + design tokens
|
||||
├─ 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/anatomy/ @faunosteo/anatomy: legacy importer, curation pipeline, annotation-layer renderer + view composer
|
||||
├─ packages/pdf/ @faunosteo/pdf: browser-free PDF engine (explicit inputs, archive envelope v1, layered reader)
|
||||
├─ packages/supabase/ @faunosteo/supabase: typed client, generated types, PGlite SQL test harness
|
||||
├─ supabase/ CLI config, SQL migrations, local seed (incl. the equine sheet), pgTAP tests
|
||||
├─ docker/ entrypoint.sh + nginx.conf
|
||||
|
||||
@@ -90,8 +90,9 @@ Package-scoped: `pnpm --filter @faunosteo/app <script>`.
|
||||
|
||||
## 5. Conventions
|
||||
|
||||
- A package has `name` `@faunosteo/<name>`, `private: true` for apps, its own
|
||||
`tsconfig.json`, tests under `tests/` (apps) or beside sources (packages).
|
||||
- A package has `name` `@faunosteo/<name>`, `private: true`, its own standalone
|
||||
`tsconfig.json` (no root tsconfig), tests under `tests/` (apps and packages
|
||||
alike), `vitest` in `node` environment for packages.
|
||||
- Dependencies are declared where they are used (`apps/app/package.json`);
|
||||
the root holds only repository tooling (Prettier, pnpm).
|
||||
- Build scripts of dependencies run only for packages listed in
|
||||
|
||||
Reference in new issue
Block a user