From 685f0dd32ebbe48c4f2f06224b410106456d9a87 Mon Sep 17 00:00:00 2001 From: Scrum4Me Agent <30029041+madhura68@users.noreply.github.com> Date: Sun, 3 May 2026 00:08:55 +0200 Subject: [PATCH] docs(naming): lowercase API.md and MD3 filenames MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit Rename docs/API.md → docs/api.md and docs/MD3_Color_Scheme_Documentation.md → docs/md3-color-scheme.md. Update all internal links across 7 files. --- CLAUDE.md | 8 ++++---- docs/agent-instruction-audit.md | 14 +++++++------- docs/{API.md => api.md} | 0 docs/backlog.md | 10 +++++----- ...Scheme_Documentation.md => md3-color-scheme.md} | 0 docs/patterns/claude-question-channel.md | 2 +- docs/patterns/qr-login.md | 2 +- docs/plans/M10-qr-pairing-login.md | 6 +++--- docs/plans/M11-claude-questions.md | 4 ++-- 9 files changed, 23 insertions(+), 23 deletions(-) rename docs/{API.md => api.md} (100%) rename docs/{MD3_Color_Scheme_Documentation.md => md3-color-scheme.md} (100%) diff --git a/CLAUDE.md b/CLAUDE.md index 343db77..763e598 100644 --- a/CLAUDE.md +++ b/CLAUDE.md @@ -21,7 +21,7 @@ Lees het relevante document voordat je aan een feature begint. Nooit gokken over | `docs/backlog.md` | Welke task bouwen, volgorde, "done when"-criteria | | `docs/personas.md` | Lars (primair), Dina, Remi — gebruik bij UI-beslissingen | | `docs/product-backlog.md` | Historische domein-backlog (referentie); seed wordt sinds ST-004 gegenereerd uit `backlog.md` via `prisma/seed-data/parse-backlog.ts` | -| `docs/API.md` | REST-API contract voor Claude Code — endpoints, status-enums, foutcodes, voorbeeld-curls | +| `docs/api.md` | REST-API contract voor Claude Code — endpoints, status-enums, foutcodes, voorbeeld-curls | | `docs/styling.md` | **Lees dit voor elk component** — MD3-kleuren, shadcn patronen | | `docs/agent-instruction-audit.md` | Waarom de agent-instructies zijn aangescherpt; checklist voor toekomstige wijzigingen | | `docs/plans/-*.md` | Implementatieplan per milestone — Bestanden, Stappen, Aandachtspunten, Verificatie. Lees vóór je aan een ST begint. Milestone-key matcht backlog-header (`M9`, `M3.5`, `PBI-9`, …). | @@ -176,7 +176,7 @@ Volledige Zod-schema in `lib/env.ts`. `.env.example` is de canonieke lijst voor - **Docs-sync:** elke gedrags-, dependency-, API- of deploymentwijziging werkt README, relevante docs en patterns bij in dezelfde change - **Entity codes:** gebruik product/PBI/story-codes in commit-titles wanneer aanwezig (`feat(ST-356.2): ...`); branchnaam blijft `feat/ST-XXX-slug` - **Status-enums op API:** lowercase (`todo|in_progress|review|done`, `open|in_sprint|done`); DB houdt UPPER_SNAKE; conversie uitsluitend via `lib/task-status.ts`-mappers — nooit ad-hoc `.toLowerCase()` elders -- **Foutcodes API:** `400` alleen voor malformed JSON-body (parse-fout via `request.json()`); `422` voor zod-validatie en well-formed-maar-niet-acceptabel; `403` voor demo-tokens. Documenteer per endpoint in `docs/API.md` +- **Foutcodes API:** `400` alleen voor malformed JSON-body (parse-fout via `request.json()`); `422` voor zod-validatie en well-formed-maar-niet-acceptabel; `403` voor demo-tokens. Documenteer per endpoint in `docs/api.md` - **Tests volgen contract:** bij een API-contract-wijziging (status, foutcode, response-shape) MOET in dezelfde commit ook `__tests__/api/` mee — een test die rood gaat omdat de oude waarde wordt verwacht is een onvolledige wijziging, niet een "kapotte test" - **Dev port:** `npm run dev` draait altijd op **3000**. Een `predev`-hook killt vooraf elk proces op 3000 (stale Next.js dev-server, vorige sessie) zodat sessies, cookies en MCP-config consistent op één poort werken. Wijk hier niet van af — geen `-p 3001` o.i.d. tenzij je expliciet twee dev-servers naast elkaar wil draaien @@ -352,7 +352,7 @@ Wekelijks (maandag 08:00 Amsterdam) draait de remote agent `trig_015FFUnxjz9WMuh - **Sharp** moet Linux-binaries hebben voor de Vercel-runtime: `npm i --include=optional sharp` of platform-specifieke deps configureren in `package.json` - **Externe image hostnames** in `next.config.js` `images.remotePatterns` configureren *vóór* `next/image` op die hosts wijst — anders 500 in productie -- **Vercel cron**: Hobby-plan staat alleen daily crons toe (max 1×/dag); Pro ondersteunt fijnmaziger. Bij wijziging van `vercel.json` `crons` ook `docs/API.md` + relevante pattern-docs updaten +- **Vercel cron**: Hobby-plan staat alleen daily crons toe (max 1×/dag); Pro ondersteunt fijnmaziger. Bij wijziging van `vercel.json` `crons` ook `docs/api.md` + relevante pattern-docs updaten - **`CRON_SECRET`** moet als env-var op de Vercel-project-omgeving staan vóór de eerste cron-run, anders 401 op `/api/cron/*`-endpoints - **Preflight** vóór deploy: `npm run lint && npm test && npm run build` — falende build laat een PR niet door (CI blokkeert merge per ST-610) @@ -364,7 +364,7 @@ M7 (MCP-server) is post-MVP en heeft eigen acceptatie in `docs/backlog.md`. - [ ] Alle 62 tasks (ST-001 t/m ST-612) afgerond - [ ] Volledige Lars-flow zonder fouten (ST-612) -- [ ] Alle gedocumenteerde API-endpoints werken via curl (zie `docs/API.md`) +- [ ] Alle gedocumenteerde API-endpoints werken via curl (zie `docs/api.md`) - [ ] Demo-gebruiker heeft geen schrijfrechten - [ ] App opzetbaar via README zonder extra hulp - [ ] CI/CD actief — falende build blokkeert merge diff --git a/docs/agent-instruction-audit.md b/docs/agent-instruction-audit.md index 5f15a23..df396ff 100644 --- a/docs/agent-instruction-audit.md +++ b/docs/agent-instruction-audit.md @@ -100,7 +100,7 @@ Sinds ronde 1 (2026-04-25) is er substantieel werk geland dat de agent-workflow - **ST-509** Todo description (max 2000) - **ST-511** Entity codes voor Product/PBI/Story (auto-default + manual override + retry op race condition) - **ST-512** REST API uitgebreid met `code`, `description`, `implementation_plan` in alle endpoints -- **ST-513** API hardening voor Claude Code: `GET /api/health`, `GET /api/products/:id/claude-context`, lowercase status-enums op de API-grens, `StoryLog.metadata` JSONB, validatie-fouten van `400` → `422`, nieuwe `docs/API.md` +- **ST-513** API hardening voor Claude Code: `GET /api/health`, `GET /api/products/:id/claude-context`, lowercase status-enums op de API-grens, `StoryLog.metadata` JSONB, validatie-fouten van `400` → `422`, nieuwe `docs/api.md` - **PR #2 Codex-review-saga** — 8 testbestanden faalden bij de contract-flip; tests werden niet meebijgewerkt. Twee P2-issues van Codex: malformed JSON moet `400` blijven (P2.1), en `status: review` werd geaccepteerd terwijl de sprint-UI er niet mee om kan gaan (P2.2) - **M7: scrum4me-mcp** — aparte MCP-server repo (`madhura68/scrum4me-scrum4me-mcp`) met 9 tools en 1 prompt voor Claude Code, schema gedeeld via git submodule - **lib/code.ts vs lib/code-server.ts** — gesplitst om client-bundle vrij te houden van `pg` (gaf eerst `Module not found: 'dns'` build-error) @@ -110,12 +110,12 @@ Sinds ronde 1 (2026-04-25) is er substantieel werk geland dat de agent-workflow | Wijziging | Code-locatie | Documentatie bijgewerkt | |---|---|---| -| Lowercase status-enums op REST-grens, mappers naar DB-enum | `lib/task-status.ts`, `app/api/tasks/[id]/route.ts`, `app/api/sprints/[id]/tasks/route.ts`, `app/api/products/[id]/next-story/route.ts` | `docs/API.md`, `CLAUDE.md` | -| 400 (malformed JSON) gescheiden van 422 (zod-validatie) | `app/api/tasks/[id]/route.ts`, `app/api/stories/[id]/tasks/reorder/route.ts`, `app/api/todos/route.ts`, `app/api/stories/[id]/log/route.ts` | `docs/API.md`, `CLAUDE.md` | -| `status: review` geweigerd door PATCH `/api/tasks/:id` zolang sprint-UI geen REVIEW rendert | `app/api/tasks/[id]/route.ts` | `docs/API.md` | +| Lowercase status-enums op REST-grens, mappers naar DB-enum | `lib/task-status.ts`, `app/api/tasks/[id]/route.ts`, `app/api/sprints/[id]/tasks/route.ts`, `app/api/products/[id]/next-story/route.ts` | `docs/api.md`, `CLAUDE.md` | +| 400 (malformed JSON) gescheiden van 422 (zod-validatie) | `app/api/tasks/[id]/route.ts`, `app/api/stories/[id]/tasks/reorder/route.ts`, `app/api/todos/route.ts`, `app/api/stories/[id]/log/route.ts` | `docs/api.md`, `CLAUDE.md` | +| `status: review` geweigerd door PATCH `/api/tasks/:id` zolang sprint-UI geen REVIEW rendert | `app/api/tasks/[id]/route.ts` | `docs/api.md` | | Entity codes (Product/PBI/Story) met auto-default + retry-on-P2002 | `actions/products.ts`, `actions/pbis.ts`, `actions/stories.ts`, `lib/code.ts`, `lib/code-server.ts` | `docs/backlog.md` (ST-511) | -| `StoryLog.metadata` JSONB | `prisma/schema.prisma`, `prisma/migrations/20260426214905_add_story_log_metadata/`, `app/api/stories/[id]/log/route.ts` | `docs/API.md` | -| Health- en bundled-context endpoints voor Claude Code | `app/api/health/route.ts`, `app/api/products/[id]/claude-context/route.ts` | `docs/API.md`, `CLAUDE.md` | +| `StoryLog.metadata` JSONB | `prisma/schema.prisma`, `prisma/migrations/20260426214905_add_story_log_metadata/`, `app/api/stories/[id]/log/route.ts` | `docs/api.md` | +| Health- en bundled-context endpoints voor Claude Code | `app/api/health/route.ts`, `app/api/products/[id]/claude-context/route.ts` | `docs/api.md`, `CLAUDE.md` | | MCP-server gepubliceerd als aparte repo | `madhura68/scrum4me-scrum4me-mcp` (extern) | `CLAUDE.md` (sectie MCP-integratie), `docs/backlog.md` (M7) | ## Nieuwe preventieve regels @@ -140,7 +140,7 @@ API exposeert lowercase, DB houdt UPPER_SNAKE. Conversie uitsluitend via `lib/ta - `400`: parse-fout op `request.json()` — wikkel altijd in `try/catch` - `422`: zod-validatie of well-formed-maar-niet-acceptabel (bv. `task_id` van andere story) - `403`: demo-token op write -- Documenteer per endpoint in `docs/API.md` +- Documenteer per endpoint in `docs/api.md` ### Client/server module-boundary diff --git a/docs/API.md b/docs/api.md similarity index 100% rename from docs/API.md rename to docs/api.md diff --git a/docs/backlog.md b/docs/backlog.md index a34c4a1..d983f47 100644 --- a/docs/backlog.md +++ b/docs/backlog.md @@ -409,8 +409,8 @@ De MVP is klaar wanneer Lars — de primaire persona — de volledige cyclus kan - **`PATCH /api/tasks/:id`:** accepteert lowercase `status` via mapper; retourneert lowercase - **Story-log metadata:** nieuwe optionele `metadata Json?` kolom op `StoryLog`; `POST /api/stories/:id/log` accepteert per type een optioneel `metadata`-veld (bv. `{ branch: 'feat/x' }`); bestaande velden ongewijzigd → backwards-compatible - **Foutcodes:** Zod-validatie geeft `422` (was `400`); `400` blijft voor malformed body; `401`/`403`/`404`/`500` ongewijzigd - - **API-documentatie:** nieuwe `docs/API.md` met endpoints, request/response, foutcodes, status-enums en curl-voorbeelden; `CLAUDE.md` verwijst ernaar - - Done when: `curl /api/health` werkt zonder auth; `curl /api/products/:id/claude-context` retourneert bundled JSON; PATCH/PUT routes accepteren lowercase status en geven 422 bij ongeldige body; story-log POST bewaart `metadata`; `docs/API.md` is gepubliceerd + - **API-documentatie:** nieuwe `docs/api.md` met endpoints, request/response, foutcodes, status-enums en curl-voorbeelden; `CLAUDE.md` verwijst ernaar + - Done when: `curl /api/health` werkt zonder auth; `curl /api/products/:id/claude-context` retourneert bundled JSON; PATCH/PUT routes accepteren lowercase status en geven 422 bij ongeldige body; story-log POST bewaart `metadata`; `docs/api.md` is gepubliceerd - **`GET /api/products`:** voeg `code` toe (naast `id`, `name`, `repo_url`); optioneel `description` en `definition_of_done` - **`GET /api/products/:id/next-story`:** voeg `code` toe op story; voeg per task `code` (derived `${story.code}.${index_in_story}`) en `implementation_plan` toe - **`GET /api/sprints/:id/tasks`:** voeg `description`, `implementation_plan` en `story_code` toe per task; voeg een derived `code`-veld per task toe (`${story.code}.${index_in_story}`) @@ -547,7 +547,7 @@ Filtering server-side: alleen events binnen de actieve sprint van een product wa - Done when: twee tabs van Solo Paneel — mutatie in tab A komt binnen 1–2s in tab B zonder refresh - [x] **ST-806** Documentatie + acceptatietest - - Sectie "Realtime updates" in `docs/architecture.md` met diagram en filtering-regels; vermelding in `CLAUDE.md`; korte note over `/api/realtime/solo` in `docs/API.md`; handmatig E2E-scenario's gedraaid (zelfde gebruiker twee tabs, MCP-write, REST-write, story-claim, network-flap) + - Sectie "Realtime updates" in `docs/architecture.md` met diagram en filtering-regels; vermelding in `CLAUDE.md`; korte note over `/api/realtime/solo` in `docs/api.md`; handmatig E2E-scenario's gedraaid (zelfde gebruiker twee tabs, MCP-write, REST-write, story-claim, network-flap) - Done when: alle scenario's lopen door zonder onverwachte gedragingen Volledig plan in `.Plans/2026-04-27-m8-realtime-solo.md` (lokaal, niet gecommit). @@ -646,7 +646,7 @@ Volledige flow + threat-model: `docs/patterns/qr-login.md` (op te leveren in ST- - Done when: end-to-end happy path werkt op localhost (twee browsers): A toont QR → B scant + bevestigt → A redirect naar `/dashboard` met `session.paired === true`; QR vernieuwt na expiry; geen secret zichtbaar in DevTools Network-tab onder URL-kolommen - [ ] **ST-1008** Documentatie + acceptatietest - - **`docs/API.md`:** drie nieuwe endpoints (start/stream/claim) met request/response, cookie-mechaniek, foutcodes (400/401/403/404/410/422/429), curl-voorbeelden inclusief `--cookie-jar` + - **`docs/api.md`:** drie nieuwe endpoints (start/stream/claim) met request/response, cookie-mechaniek, foutcodes (400/401/403/404/410/422/429), curl-voorbeelden inclusief `--cookie-jar` - **`docs/architecture.md`:** sectie "QR-pairing flow" met sequence-diagram + threat-model; expliciete subsectie *"Waarom geen secret in URL"* — fragments worden niet naar server gestuurd; SSE/claim authenticeren via HttpOnly cookie zodat secret-materiaal niet in access logs / reverse-proxy logs / observability-tools / browsergeschiedenis kan belanden - **`docs/patterns/qr-login.md`:** nieuw pattern-doc voor toekomstige features die hetzelfde unauth-SSE-via-pre-auth-cookie-patroon willen hergebruiken - **`CLAUDE.md`:** verwijzing naar het nieuwe pattern-doc in de patterns-tabel @@ -713,7 +713,7 @@ Persistent vraag-antwoord-kanaal tussen Claude Code (via MCP) en de actieve Scru - Done when: handmatige `curl -X POST` met secret expireert oude rijen; Vercel-dashboard toont cron-config na deploy; onbevoegde call → 401 - [ ] **ST-1108** Documentatie + acceptatietest - - **`docs/API.md`:** secties "SSE — Notifications" + "Cron — Expire questions" met curl-voorbeelden + - **`docs/api.md`:** secties "SSE — Notifications" + "Cron — Expire questions" met curl-voorbeelden - **`docs/architecture.md`:** sectie "Vraag-antwoord-kanaal Claude ↔ user" met Mermaid sequence-diagram + threat-model + "Waarom hergebruik scrum4me_changes-kanaal" - **`docs/patterns/claude-question-channel.md`:** nieuw herbruikbaar pattern-doc voor toekomstige bidirectionele async-communicatie tussen MCP-agents en interactieve users - **`CLAUDE.md`:** rij in Implementatiepatronen-tabel voor het nieuwe pattern diff --git a/docs/MD3_Color_Scheme_Documentation.md b/docs/md3-color-scheme.md similarity index 100% rename from docs/MD3_Color_Scheme_Documentation.md rename to docs/md3-color-scheme.md diff --git a/docs/patterns/claude-question-channel.md b/docs/patterns/claude-question-channel.md index d8f673a..dc5daa9 100644 --- a/docs/patterns/claude-question-channel.md +++ b/docs/patterns/claude-question-channel.md @@ -139,7 +139,7 @@ Specifiek voor M11. Kopieer en pas aan: - Volledige flow + threat-model: `docs/architecture.md` § Vraag- antwoord-kanaal Claude ↔ user -- Endpoint-contract: `docs/API.md` § Notifications + Cron +- Endpoint-contract: `docs/api.md` § Notifications + Cron - LISTEN/NOTIFY-pattern: `app/api/realtime/solo/route.ts` (M8 ST-802) — zelfde ReadableStream + heartbeat + hard-close + abort-cleanup - M10 vs M11 keuze tussen eigen/gedeeld kanaal: zie threat-model-tabel diff --git a/docs/patterns/qr-login.md b/docs/patterns/qr-login.md index 30cbf33..d27279b 100644 --- a/docs/patterns/qr-login.md +++ b/docs/patterns/qr-login.md @@ -90,6 +90,6 @@ Drie tijden in escalerende volgorde, alle korter dan de reguliere sessie: ## Referenties - Volledige flow + threat-model: `docs/architecture.md` § QR-pairing flow -- Endpoint-contract: `docs/API.md` § Auth — QR-pairing +- Endpoint-contract: `docs/api.md` § Auth — QR-pairing - LISTEN/NOTIFY-pattern: `app/api/realtime/solo/route.ts` (M8 ST-802) — zelfde ReadableStream + heartbeat + hard-close + abort-cleanup, alleen ander channel diff --git a/docs/plans/M10-qr-pairing-login.md b/docs/plans/M10-qr-pairing-login.md index 56931af..0778073 100644 --- a/docs/plans/M10-qr-pairing-login.md +++ b/docs/plans/M10-qr-pairing-login.md @@ -788,7 +788,7 @@ ST-1006 staat bij de API-laag (niet bij UI) omdat het een Route Handler is; ST-1 ## ST-1008 — Documentatie + acceptatietest **Bestanden** -- `docs/API.md` — drie nieuwe endpoints +- `docs/api.md` — drie nieuwe endpoints - `docs/architecture.md` — sectie "QR-pairing flow" + threat-model - `docs/patterns/qr-login.md` — nieuw pattern-doc - `CLAUDE.md` — verwijzing naar het pattern-doc in de patterns-tabel @@ -796,7 +796,7 @@ ST-1006 staat bij de API-laag (niet bij UI) omdat het een Route Handler is; ST-1 **Stappen** -1. **`docs/API.md`** — drie endpoints documenteren met request/response, foutcodes (400/401/403/404/410/422/429), curl-voorbeelden inclusief `--cookie-jar`. Voeg een sectie *"Cookie-mechaniek"* toe die uitlegt dat `s4m_pair` een tijdelijke pre-auth cookie is, anders dan de iron-session cookie. +1. **`docs/api.md`** — drie endpoints documenteren met request/response, foutcodes (400/401/403/404/410/422/429), curl-voorbeelden inclusief `--cookie-jar`. Voeg een sectie *"Cookie-mechaniek"* toe die uitlegt dat `s4m_pair` een tijdelijke pre-auth cookie is, anders dan de iron-session cookie. 2. **`docs/architecture.md`** — sectie *"QR-pairing flow"* met: - Sequence-diagram (mermaid of ASCII analoog aan M8) @@ -857,7 +857,7 @@ feat(ST-1005): add mobile pair confirmation page with hash-fragment client islan feat(ST-1006): add /api/auth/pair/claim with atomic consume chore(ST-1007): add qrcode.react dependency feat(ST-1007): add QR login button on /login with SSE listener -docs(ST-1008): document QR-pairing endpoints in API.md +docs(ST-1008): document QR-pairing endpoints in api.md docs(ST-1008): add QR-pairing flow and threat-model to architecture docs(ST-1008): add qr-login pattern doc ``` diff --git a/docs/plans/M11-claude-questions.md b/docs/plans/M11-claude-questions.md index ddcd171..f485f4d 100644 --- a/docs/plans/M11-claude-questions.md +++ b/docs/plans/M11-claude-questions.md @@ -369,7 +369,7 @@ Backlog-entries: zie [backlog.md § M11](../backlog.md#m11-claude-vraagt-gebruik ## ST-1108 — Documentatie + acceptatietest **Bestanden** -- `docs/API.md` — secties "SSE — Notifications" + "Cron — Expire questions" +- `docs/api.md` — secties "SSE — Notifications" + "Cron — Expire questions" - `docs/architecture.md` — sectie "Vraag-antwoord-kanaal" met sequence-diagram - `docs/patterns/claude-question-channel.md` — herbruikbaar pattern-doc - `docs/backlog.md` — M11-tabel-rij + M11-sectie @@ -430,7 +430,7 @@ feat(ST-1105): add NotificationsBell + Sheet + AnswerModal chore(ST-1107): add CRON_SECRET to env schema feat(ST-1107): add /api/cron/expire-questions handler feat(ST-1107): wire vercel.ts cron entry -docs(ST-1108): document notifications SSE + cron in API.md +docs(ST-1108): document notifications SSE + cron in api.md docs(ST-1108): add vraag-antwoord-kanaal flow to architecture docs(ST-1108): add claude-question-channel pattern doc chore(ST-1108): backlog M11 + parser ACTIVE-flip