janpeter/Scrum4Me
0
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions 3

docs(taxonomy): move design/api/qa/backlog/assets into folders

Browse source
This commit is contained in:
Janpeter Visser 2026-05-03 00:56:03 +02:00
parent 2e47bda28e
commit 90ee122641
28 changed files with 83 additions and 83 deletions
Download patch file Download diff file Expand all files Collapse all files

8
docs/plans/M10-qr-pairing-login.md
View file

@ -776,7 +776,7 @@ ST-1006 staat bij de API-laag (niet bij UI) omdat het een Route Handler is; ST-1
<QrLoginButton />
```
MD3-tokens uit `docs/styling.md`; geen willekeurige Tailwind-kleuren.
MD3-tokens uit `docs/design/styling.md`; geen willekeurige Tailwind-kleuren.
4. **A11y**: QR-component krijgt `aria-label="QR-code voor mobiel inloggen"` en de URL wordt visueel als kopieer-bare tekst onder de QR getoond zodat screenreaders en gebruikers met cameraproblemen de URL handmatig kunnen openen.
@ -797,7 +797,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/rest-contract.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
@ -805,7 +805,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/rest-contract.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)
@ -835,7 +835,7 @@ ST-1006 staat bij de API-laag (niet bij UI) omdat het een Route Handler is; ST-1
7. **Secret niet in access logs** — controleer Vercel runtime-logs (via `mcp__a1fa0fcf-…__get_runtime_logs`) en lokale dev-logs; zoek op de secret-string en op `s=`-substrings; verwacht: 0 hits
**Aandachtspunten**
- Zorg dat de runtime-logs MCP-controle in `docs/test-plan.md` belandt zodat hij bij elke release herhaalbaar is.
- Zorg dat de runtime-logs MCP-controle in `docs/qa/api-test-plan.md` belandt zodat hij bij elke release herhaalbaar is.
- `docs/patterns/qr-login.md` mag refereren naar bestaande pattern-docs (iron-session, route-handler) zonder ze te dupliceren.
**Verificatie**

8
docs/plans/M11-claude-questions.md
View file

@ -288,7 +288,7 @@ Backlog-entries: zie [backlog.md § M11](../backlog.md#m11-claude-vraagt-gebruik
**Aandachtspunten**
- Bell-icon en avatar moeten visueel balanceren — hoogte/padding gelijktrekken
- MD3-tokens uit `docs/styling.md`: badge `bg-error text-error-foreground` voor critical-count, `bg-primary` voor neutraal. Geen willekeurige Tailwind-kleuren
- MD3-tokens uit `docs/design/styling.md`: badge `bg-error text-error-foreground` voor critical-count, `bg-primary` voor neutraal. Geen willekeurige Tailwind-kleuren
- Optimistic-answer in store: voor het Server Action-resultaat zet item op pending; bij error rollback met sonner-error-toast
- Sheet-content blijft open zodat de user meerdere vragen achter elkaar kan beantwoorden (zelfde patroon als ST-358 openstaande-stories-sheet)
- ARIA: bell-icon heeft `aria-label="Notificaties — N open vragen"`, badge `role="status"`
@ -378,16 +378,16 @@ 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/rest-contract.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
- `docs/backlog/index.md` — M11-tabel-rij + M11-sectie
- `prisma/seed-data/parse-backlog.ts` — `M11: 'ACTIVE'`, `M10: 'COMPLETED'`, `M3.5: 'COMPLETED'`
- `CLAUDE.md` — pattern-doc verwijzing in Implementatiepatronen-tabel
**Stappen**
1. Backlog-tabel-rij + M11-sectie in `docs/backlog.md` (mirror M10-format met **Implementatieplan:** verwijzing naar dit doc)
1. Backlog-tabel-rij + M11-sectie in `docs/backlog/index.md` (mirror M10-format met **Implementatieplan:** verwijzing naar dit doc)
2. `docs/architecture.md` § "Vraag-antwoord-kanaal":
- Mermaid sequence-diagram: Claude → MCP → DB → trigger → SSE → user → Server Action → DB → trigger → polling-tool

8
docs/plans/archive/2026-04-27-claude-md-workflow-update.md
View file

@ -47,7 +47,7 @@ Voeg toe onder de bestaande tabel:
|---|---|
| `https://github.com/madhura68/scrum4me-mcp` | MCP-server repo: tools, prompts, schema-sync workflow |
(`docs/api.md` staat er al — laten staan.)
(`docs/api/rest-contract.md` staat er al — laten staan.)
### 2. Sectie "Waar te beginnen" — herschrijven
@ -65,7 +65,7 @@ Vervang de 7-stap manual loop door een dual-track:
```
**Track B — manueel (Codex of zonder MCP)**:
- Lees task in `docs/backlog.md`
- Lees task in `docs/backlog/index.md`
- Volg verder de bestaande 7-stappen-loop
### 3. Sectie "Implementatiepatronen" — uitbreiden
@ -83,7 +83,7 @@ Voeg toe aan de bestaande lijst:
- **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 via `lib/task-status.ts`-mappers — nooit ad-hoc lowercase elders
- **Foutcodes API**: `400` alleen voor malformed JSON-body (parse-fout); `422` voor zod-validatie en well-formed-maar-niet-acceptabel; `403` voor demo-tokens. Documenteren in `docs/api.md`
- **Foutcodes API**: `400` alleen voor malformed JSON-body (parse-fout); `422` voor zod-validatie en well-formed-maar-niet-acceptabel; `403` voor demo-tokens. Documenteren in `docs/api/rest-contract.md`
- **Tests volgen contract**: bij API-contract-wijziging (status, foutcode, response-shape) MOET in dezelfde commit ook `__tests__/api/` bijgewerkt worden — een falende test op review betekent niet dat de tests "stuk zijn" maar dat de wijziging onvolledig is
### 5. Nieuwe sectie "MCP-integratie" — toevoegen vóór "Definition of Done"
@ -118,7 +118,7 @@ stilletjes breekt op runtime.
### 6. Sectie "Definition of Done" — kop verduidelijken
Wijzig `## Definition of Done` → `## Definition of Done (MVP)` en voeg eronder een korte zin toe: *"M7 (MCP-server) is post-MVP en heeft eigen acceptatie in `docs/backlog.md`."*
Wijzig `## Definition of Done` → `## Definition of Done (MVP)` en voeg eronder een korte zin toe: *"M7 (MCP-server) is post-MVP en heeft eigen acceptatie in `docs/backlog/index.md`."*
## Bijwerken van auditdoc

6
docs/plans/archive/2026-04-27-insert-milestone-tool.md
View file

@ -17,12 +17,12 @@ Eén commando dat een specifieke milestone (PBI + stories + tasks) uit de backlo
Twee bronnen denkbaar:
- **`.Plans/<datum>-<slug>.md`** — freeform plan-tekst, niet gestructureerd, niet gecommit
- **`docs/backlog.md`** — al strict gestructureerd, gecommit, single source of truth voor alle bestaande seed-pipelines
- **`docs/backlog/index.md`** — al strict gestructureerd, gecommit, single source of truth voor alle bestaande seed-pipelines
Voorstel: het script leest de **backlog**. Workflow blijft natuurlijk:
1. Plan schrijven naar `.Plans/<naam>.md` (lokaal, draft)
2. Milestone-sectie + stories formaliseren in `docs/backlog.md` (PR)
2. Milestone-sectie + stories formaliseren in `docs/backlog/index.md` (PR)
3. Na merge: `npm run db:insert-milestone -- M8 [--product SCRUM4ME]`
Eén canonical bron, geen ambiguïteit, en de bestaande parser doet 90% van het werk al.
@ -49,7 +49,7 @@ Default product code: SCRUM4ME
Logica:
1. Parse args; valideer dat milestone-key matcht `^M[\d.]+$`
2. `loadBacklog(repoRoot, { strict: false })`
3. Zoek milestone op `key`; faal helder met "milestone <key> not found in docs/backlog.md" als ie er niet in staat
3. Zoek milestone op `key`; faal helder met "milestone <key> not found in docs/backlog/index.md" als ie er niet in staat
4. Lookup product via `code` (default `SCRUM4ME`); faal als niet gevonden
5. Upsert PBI:
- `where: { product_id_code: { product_id, code: milestone.key } }`

4
docs/plans/archive/2026-04-27-m8-realtime-solo.md
View file

@ -134,13 +134,13 @@ Strategie: combineer (a) trigger zet `product_id` en `assignee_id` in de payload
### ST-806 Documentatie + acceptatietest
- Update `docs/architecture.md`: nieuwe sectie "Realtime updates" met diagram en filtering-regels
- Update `CLAUDE.md`: vermelding dat Solo Paneel realtime is + dat MCP-writes vanzelf doorkomen
- Update `docs/api.md`: korte note over `/api/realtime/solo` (Bearer auth, SSE format)
- Update `docs/api/rest-contract.md`: korte note over `/api/realtime/solo` (Bearer auth, SSE format)
- E2E-acceptatie: lijst van scenario's (zelfde gebruiker twee tabs, MCP-write, REST-write, story-claim, network-flap) handmatig getest
- Done when: scenario's lopen door zonder onverwachte gedragingen
## Backlog-edits
In `docs/backlog.md`:
In `docs/backlog/index.md`:
1. **Milestone-overzicht** — rij toevoegen onder M7:
```

28
docs/plans/docs-restructure-pbi-spec.md
View file

@ -267,15 +267,15 @@ pbi:
description: "8 spec/backlog/styling files at docs/ root."
implementation_plan: |
git mv docs/architecture.md docs/architecture.md
git mv docs/backlog.md docs/backlog.md
git mv docs/backlog/index.md docs/backlog/index.md
git mv docs/specs/functional.md docs/specs/functional.md
git mv docs/specs/dialogs/pbi.md docs/specs/dialogs/pbi.md
git mv docs/specs/personas.md docs/specs/personas.md
git mv docs/product-backlog.md docs/product-backlog.md
git mv docs/backlog/product-historical.md docs/backlog/product-historical.md
git mv docs/specs/dialogs/story.md docs/specs/dialogs/story.md
git mv docs/styling.md docs/styling.md
git mv docs/design/styling.md docs/design/styling.md
git mv docs/specs/dialogs/task.md docs/specs/dialogs/task.md
git mv docs/test-plan.md docs/test-plan.md
git mv docs/qa/api-test-plan.md docs/qa/api-test-plan.md
# update every internal link
grep -rln "" docs/ CLAUDE.md AGENTS.md README.md \
| xargs sed -i '' 's|||g'
@ -286,8 +286,8 @@ pbi:
- title: "Lowercase api.md and MD3 file"
description: "Two files use non-kebab capitalization."
implementation_plan: |
git mv docs/api.md docs/api.md
git mv docs/md3-color-scheme.md docs/md3-color-scheme.md
git mv docs/api/rest-contract.md docs/api/rest-contract.md
git mv docs/design/md3-color-scheme.md docs/design/md3-color-scheme.md
grep -rln "API\.md\|MD3_Color_Scheme" docs/ CLAUDE.md AGENTS.md README.md \
| xargs sed -i '' 's|API\.md|api.md|g; s|md3-color-scheme|md3-color-scheme|g'
npm run docs:index
@ -371,14 +371,14 @@ pbi:
- title: "Move design + api + qa + backlog + assets"
description: "Bulk move per topic."
implementation_plan: |
git mv docs/styling.md docs/design/styling.md
git mv docs/md3-color-scheme.md docs/design/md3-color-scheme.md
git mv docs/api.md docs/api/rest-contract.md
git mv docs/test-plan.md docs/qa/api-test-plan.md
git mv docs/backlog.md docs/backlog/index.md
git mv docs/product-backlog.md docs/backlog/product-historical.md
git mv docs/erd.svg docs/assets/erd.svg
git mv docs/icons.html docs/assets/icons.html
git mv docs/design/styling.md docs/design/styling.md
git mv docs/design/md3-color-scheme.md docs/design/md3-color-scheme.md
git mv docs/api/rest-contract.md docs/api/rest-contract.md
git mv docs/qa/api-test-plan.md docs/qa/api-test-plan.md
git mv docs/backlog/index.md docs/backlog/index.md
git mv docs/backlog/product-historical.md docs/backlog/product-historical.md
git mv docs/assets/erd.svg docs/assets/erd.svg
git mv docs/assets/icons.html docs/assets/icons.html
# update links — sed sweep
commit: docs(taxonomy): move design/api/qa/backlog/assets into folders
priority: 2

2
docs/plans/tweede-claude-agent-planning.md
View file

@ -214,7 +214,7 @@ Korte prompt-flow:
- `docs/specs/functional.md` (functioneel kader)
- `docs/architecture.md` (technisch kader)
- `docs/patterns/*.md` (relevante patterns op basis van target-titel/-beschrijving)
- `docs/styling.md` als target UI-werk betreft
- `docs/design/styling.md` als target UI-werk betreft
4. Bedenk children:
- Voor `STORY`-target: 3-7 taken met titel, korte beschrijving, `implementation_plan` (verwijst naar relevante patterns + bestanden), priority
- Voor `PBI`-target: 2-5 stories met titel, beschrijving in user-story-format, acceptance_criteria, priority