From 2ff58ace46e5feea4eb0c67a51772e7a6980e8f5 Mon Sep 17 00:00:00 2001 From: Lucas Winther Date: Fri, 23 Oct 2026 19:13:41 +0200 Subject: [PATCH] =?UTF-8?q?docs:=20final=20review=20fixes=20=E2=80=94=20de?= =?UTF-8?q?ferred=20backlog,=20doc=20accuracy,=20sample-data=20note?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit Co-Authored-By: Claude Opus 5.5 --- AGENTS.md | 4 ++-- docs/ARCHITECTURE.md | 2 +- docs/PERMISSIONS.md | 10 ++++++++- docs/TODO.md | 47 +++++++++++++++++++++++++++++++++++++--- src/data/sample.ts | 24 ++++++++++---------- src/index.html | 2 +- src/index.ts | 2 +- src/server.ts | 30 ++++++++++++------------- src/shared/audio-slot.ts | 2 +- tests/server.test.ts | 5 +++++ tests/shared.test.ts | 12 ++++++++++ 11 files changed, 103 insertions(+), 37 deletions(-) diff --git a/AGENTS.md b/AGENTS.md index a142a46..b99fb17 100644 --- a/AGENTS.md +++ b/AGENTS.md @@ -36,7 +36,7 @@ bun dist/server.js # wrong: crashes with 'Bundled file "./index-….js" no - Assets are bundled, never loaded from a CDN: fonts from `@fontsource/*`, three.js from npm. YouTube videos are link cards (`createVideoCards`), not embeds. - Adding a mockup route means editing `src/server.ts`, `src/mockups/registry.ts` and the cards in - `src/index.html` together; `tests/server.test.ts` checks they agree. + `src/index.html` together; `tests/server.test.ts` checks every registry slug is served and that the index shows each entry's name, pitch and tryThis. ## Workflow @@ -69,7 +69,7 @@ Mockup rounds — any UI change beyond a trivial tweak, while brainstorming and `src/server.ts` -> `Bun.serve` with HTML-import routes: `/` and `/mockups/NN-slug/` `src/data/` -> `types.ts` (shapes), `sample.ts` (shared sample data), `query.ts` (helpers) `src/shared/` -> credits, audio slot (direct MP3, empty state), YouTube link cards -`src/mockups/NN-slug/` -> one design direction each: `index.html`, `main.ts`, `style.css` +`src/mockups/NN-slug/` -> one design direction each: `index.html`, `main.ts`, `style.css`, plus optional helper modules (e.g. `scene.ts`, `layout.ts`) `tests/` -> data invariants, shared DOM modules (happy-dom), route smoke tests Full picture: `docs/ARCHITECTURE.md` — read it before your first change in a session. diff --git a/docs/ARCHITECTURE.md b/docs/ARCHITECTURE.md index d654a28..9772cd0 100644 --- a/docs/ARCHITECTURE.md +++ b/docs/ARCHITECTURE.md @@ -14,7 +14,7 @@ shared credits snippet. | `src/server.ts` | `startServer(port)`: routes `/`, `/mockups/NN-slug/` (+ 302 from the no-slash form), 404 otherwise. Runs when `import.meta.main`; `PORT` env, default 3000. | | `src/index.html`, `src/index.ts`, `src/index.css` | Index page: static cards linking each mockup, then `mountCredits()`. | | `src/mockups/registry.ts` | `mockups: MockupInfo[]` — slug, number, name, pitch, what to try. | -| `src/mockups/NN-slug/` | One design direction: `index.html` (links `../../shared/credits.css`, has `