Scrum4Me/docs/INDEX.md
Janpeter Visser 7e45bbdbc0
docs: AI-optimized docs restructure (Phases 1–8) (#61)
* docs(dialog-pattern): add generic entity-dialog spec

Introduceert docs/patterns/dialog.md als bron-of-truth voor elke
create/edit/detail-dialog in Scrum4Me, ongeacht het achterliggende
dataobject. Bevat 14 secties: uitgangspunten, stack, component-
architectuur, layout, validatie, drielaagse demo-policy, submission,
dialog-gedrag, theming, footer, triggers/URL-state, per-entiteit
profile-template, out-of-scope, en een verificatie-checklist.

Registreert het patroon in CLAUDE.md "Implementatiepatronen"-tabel
zodat Claude (en mensen) de spec verplicht raadplegen voor elke
nieuwe dialog.

Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com>

* docs(dialog-pattern): convert task spec + add pbi/story entity-profiles

Reduceert docs/scrum4me-task-dialog.md van 507 naar ~140 regels: alle
gedeelde regels verhuisd naar docs/patterns/dialog.md, dit document
bevat nu alleen Task-specifieke velden, URL-pattern, status-veld,
server actions, triggers en bewuste out-of-scope-keuzes.

Voegt twee nieuwe entity-profielen toe voor bestaande dialogen:
- docs/scrum4me-pbi-dialog.md (PbiDialog: state-based, code+title-rij,
  PbiStatusSelect, geen delete in v1)
- docs/scrum4me-story-dialog.md (StoryDialog: state-based, header met
  status/priority badges, inline activity-log, demo-readonly-fallback,
  inline-delete-confirm i.p.v. AlertDialog)

Beide profielen documenteren expliciet de "Bekende gaps t.o.v.
generieke spec" zodat opvolgende PR's de afwijkingen kunnen
rechtzetten of bewust kunnen accorderen.

Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com>

* Added pdevelopment docs

* docs(plans): add docs-restructure plan for AI-optimized lookup

Audit of existing 39 doc files (~10.700 lines) and a phased restructure
proposal aimed at minimising the tokens an AI agent has to read to find
the right reference. Captures resolved decisions on language (English),
ADR template (Nygard default with MADR escape-hatch), index generator
(node script), and folder taxonomy. Proposal status — fase 1 to follow.

* docs(adr): add ADR scaffolding (templates, README, meta-ADR)

Set up docs/adr/ as the canonical home for architecture decisions:

- templates/nygard.md — default four-section format (Status, Context,
  Decision, Consequences) for one-way-door decisions.
- templates/madr.md — MADR v4 with YAML front-matter and explicit
  Considered Options for decisions where rejected alternatives matter.
- README.md — naming convention (NNNN-kebab-case), template-selection
  guidance (Nygard default; MADR for auth, queue mechanics, agent
  integration), status lifecycle, and ADR roster.
- 0000-record-architecture-decisions.md — meta-ADR establishing the
  practice itself, in Nygard format.

Backfilling existing implicit decisions (base-ui-over-radix, float
sort_order, demo-user three-layer policy, etc.) is fase 6 of the
docs-restructure plan.

* feat(docs): add docs index generator + initial INDEX.md

scripts/generate-docs-index.mjs walks docs/**/*.md, parses YAML
front-matter (or first H1 fallback) and a Nygard-style ## Status
section, then writes docs/INDEX.md with grouped tables for ADRs,
Specs, Plans (with archive subsection), Patterns, and Other.

Pure Node 20 (no external deps); idempotent — running it twice
produces byte-identical output. Excludes adr/templates/, the ADR
README, INDEX.md itself, and any *_*.md sidecar file.

Wire-up:
- package.json: docs:index → node scripts/generate-docs-index.mjs

Initial run indexed 35 docs across the existing structure; the
generated INDEX.md is committed so the table is reviewable in the
PR before hooking generation into a pre-commit step.

* chore: ignore Obsidian vault and personal sidecar files

Add .obsidian/ (Obsidian vault config) and _*.md (personal sidecar
notes) to .gitignore so the docs/ tree can serve as canonical source
of truth while still being usable as an Obsidian vault for personal
authoring. The docs index generator already excludes the same _*.md
pattern from INDEX.md.

* docs(plans): add PBI bulk-create spec for docs-restructure

Machine-parseable spec for an executor that calls the scrum4me MCP
(create_pbi → create_story → create_task) to seed the docs-restructure
work into the DB.

- Section 1 (Context) is the PBI description; serves as task-context
  via mcp__scrum4me__get_claude_context.
- Section 2 lists the 6 resolved decisions (English, MD3+styling
  merged, solo-paneel merged, .Plans archived, Nygard ADR default,
  node index script).
- Section 3 records what already shipped on this branch so the
  executor doesn't duplicate the ADR scaffolding or index generator.
- Section 4 carries the structured YAML graph: 1 PBI, 8 stories
  (one per phase), 39 tasks. product_id is REPLACE_ME — fill before
  running.
- YAML validated with PyYAML; field schema sanity-checked.

* docs(junk-cleanup): remove stub patterns/test.md

* docs(junk-cleanup): archive .Plans/ to docs/plans/archive/

* docs(front-matter): add YAML front-matter to docs/ root

* docs(front-matter): add YAML front-matter to patterns/

* docs(front-matter): add YAML front-matter to plans + agent files

* docs(index): regenerate INDEX.md after front-matter pass

* docs(naming): drop scrum4me- prefix from doc filenames

* docs(naming): lowercase API.md and MD3 filenames

* docs(naming): rename plan file to kebab-case ASCII

* docs(naming): rename middleware.md to proxy.md (next 16)

* docs(naming): polish CLAUDE.md doc-index after renames

* docs(taxonomy): scaffold topical folders under docs/

* docs(taxonomy): move spec files into docs/specs/

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

* docs(taxonomy): move agent-instruction-audit into decisions/

* docs(split): break architecture.md into 6 topical files

* docs(split): merge solo-paneel-spec into specs/functional.md

* docs(split): merge md3-color-scheme into design/styling

* docs(trim): extract branch/commit rules into runbook

* docs(trim): extract MCP integration into runbook

* docs(adr): add 0001-base-ui-over-radix

* docs(adr): add 0002-float-sort-order

* docs(adr): add 0003-one-branch-per-milestone

* docs(adr): add 0004-status-enum-mapping

* docs(adr): add 0005-iron-session-over-nextauth

* docs(adr): add 0006-demo-user-three-layer-policy

* docs(adr): add 0007-claude-question-channel-design

* docs(adr): add 0008-agent-instructions-in-claude-md + update README index

* docs(index): regenerate after ADR 0001-0008

* docs(glossary): add docs/glossary.md

* chore(docs): regenerate INDEX.md in pre-commit hook

* docs(readme): link INDEX + glossary + agent instructions

* feat(docs): add doc-link checker script

* chore(docs): wire docs:check-links and docs npm scripts

* ci(docs): block merge on broken doc links

* docs(links): fix broken cross-references after restructure

---------

Co-authored-by: Claude Opus 4.7 (1M context) <noreply@anthropic.com>
2026-05-03 03:21:59 +02:00

8 KiB

Documentation Index

Auto-generated on 2026-05-03 from front-matter and headings.

Architecture Decision Records

# Title Status
0000 ADR-0000: Record architecture decisions accepted
0001 ADR-0001: Use @base-ui/react instead of Radix UI accepted
0002 ADR-0002: Use float sort_order for drag-and-drop ordering accepted
0003 ADR-0003: One branch per milestone, push only after user test accepted
0004 ADR-0004: DB enums UPPER_SNAKE, API enums lowercase, mapped exclusively via lib/task-status.ts accepted
0005 ADR-0005: Use iron-session for authentication instead of NextAuth/Clerk/Supabase Auth accepted
0006 ADR-0006: Demo-user write protection enforced in three layers accepted
0007 ADR-0007: Agent ↔ user question channel via persistent table + LISTEN/NOTIFY accepted
0008 ADR-0008: Agent instructions in CLAUDE.md + topical runbooks accepted
0009 ADR-0009: Three-phase agent pipeline for feature ideation → plan → implementation proposed

Specifications

Title Status Updated
PbiDialog Profiel active 2026-05-03
StoryDialog Profiel active 2026-05-03
TaskDialog Profiel active 2026-05-03
Scrum4Me — Functionele Specificatie active 2026-05-03
DevPlanner — User Personas active 2026-05-03

Plans

Title Status Updated
Docs-restructuur — geoptimaliseerd voor AI-lookup proposal 2026-05-02
PBI Bulk-Create Spec — Docs-Restructure for AI-Optimized Lookup
M10 — Password-loze inlog via QR-pairing active 2026-05-03
M11 — Claude vraagt, gebruiker antwoordt active 2026-05-03
M12 — Drie-fase agent-pipeline voor feature-ideatie proposal 2026-05-03
M9 — Actief Product Backlog active 2026-05-03
ST-1109 — PBI krijgt een status (Ready / Blocked / Done) active 2026-05-03
ST-1110 — Demo gebruiker read-only active 2026-05-03
ST-1111 — Voer uit-knop met Claude Code job queue active 2026-05-03
ST-1114 — Copilot reviews op dashboard active 2026-05-03
Tweede Claude Agent — Planning Agent proposal 2026-05-03

Archive

Title Updated
CLAUDE.md workflow-update na M7 + ST-509/511/512/513 2026-05-03
Herbruikbaar scripts/insert-milestone.ts 2026-05-03
Realtime updates voor Solo Paneel (M8) 2026-05-03

Patterns

Title Status Updated
Bidirectionele async-comms MCP-agent ↔ user active 2026-05-03
Entity Dialog active 2026-05-03
iron-session active 2026-05-03
Prisma Client singleton active 2026-05-03
Proxy (route protection) active 2026-05-03
QR-pairing via unauth-SSE + pre-auth cookie active 2026-05-03
Route Handler (REST API) active 2026-05-03
Server Action active 2026-05-03
Float sort_order (drag-and-drop volgorde) active 2026-05-03
Patroon: Story met UI-component
Zustand optimistische update + rollback active 2026-05-03

Other Docs

Title Path Status Updated
Scrum4Me REST API api.md active 2026-05-03
Scrum4Me REST API api/rest-contract.md active 2026-05-03
route-handlers app/getting-started/route-handlers.md
Scrum4Me — Technische Architectuur (breadcrumb) architecture.md active 2026-05-03
Authentication, Sessions & Demo Policy architecture/auth-and-sessions.md active 2026-05-03
Claude ↔ User Question Channel architecture/claude-question-channel.md active 2026-05-03
Data Model & Prisma Schema architecture/data-model.md active 2026-05-03
Scrum4Me — Architecture Overview architecture/overview.md active 2026-05-03
Project Structure, Stores, Realtime & Job Queue architecture/project-structure.md active 2026-05-03
QR-pairing Login Flow architecture/qr-pairing.md active 2026-05-03
Scrum4Me — Implementatie Backlog backlog.md active 2026-05-03
Scrum4Me — Implementatie Backlog backlog/index.md active 2026-05-03
DevPlanner — Product Backlog backlog/product-historical.md active 2026-05-03
Agent Instruction Audit decisions/agent-instructions-history.md active 2026-05-03
Scrum4Me — Styling & Design System design/styling.md active 2026-05-03
Docker smoke test — task 1 docker-smoke/2-mei-task-1.md
Docker smoke test — task 2 docker-smoke/2-mei-task-2.md
Scrum4Me — Functionele Specificatie functional.md active 2026-05-03
Scrum4Me — Glossary glossary.md active 2026-05-03
Scrum4Me — Styling & Design System md3-color-scheme.md active 2026-05-03
Obsidian as Personal Authoring Layer obsidian-authoring.md active 2026-05-02
PbiDialog Profiel pbi-dialog.md
DevPlanner — User Personas personas.md active 2026-05-03
DevPlanner — Product Backlog product-backlog.md active 2026-05-03
Scrum4Me — API Test Plan qa/api-test-plan.md active 2026-05-03
Realtime smoke-checklist — PBI / Story / Task realtime-smoke.md
Branch, PR & Commit Strategy runbooks/branch-and-commit.md active 2026-05-03
Vercel Deployment runbooks/deploy-vercel.md active 2026-05-03
MCP Integration — Scrum4Me Tools runbooks/mcp-integration.md active 2026-05-03
StoryDialog Profiel story-dialog.md
TaskDialog Profiel task-dialog.md
Scrum4Me — API Test Plan test-plan.md active 2026-05-03