Scrum4Me/docs
Janpeter Visser bd7478861b
PBI-58: Developer manual + in-app /manual page (#148)
* docs(PBI-58): add developer manual chapters under docs/manual/

Adds a 7-file English-language manual targeted at new human contributors:
index, overview, statuses & transitions (with mermaid state diagrams),
git workflow, MCP integration, docker, and troubleshooting. The manual
is the *map* — it cross-references existing runbooks/ADRs/architecture
docs rather than duplicating their content.

Regenerates docs/INDEX.md and validates with check-doc-links.mjs.

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

* chore(PBI-58): add markdown rendering deps + manual:build script

Adds mermaid, rehype-slug, rehype-autolink-headings for the in-app
/manual page. Wires manual:build into prebuild so production builds
always regenerate the chapter TOC.

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

* feat(PBI-58): codegen script for in-app manual TOC

scripts/build-manual.mjs walks docs/manual/, parses YAML front-matter,
strips it from the body, and emits lib/manual.generated.ts with a typed
ManualEntry[] containing slug, title, description, filePath, and the
embedded markdown body. Pure Node 20, mirrors generate-docs-index.mjs.

Inlining the markdown at build time keeps runtime serverless functions
free of filesystem reads, which avoids whole-project NFT tracing.

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

* feat(PBI-58): /manual route renders developer manual chapters in-app

Catch-all route at app/(app)/manual/[[...slug]]/page.tsx with
generateStaticParams covering every TOC entry. Server-side
MarkdownView uses react-markdown with remark-gfm, rehype-slug, and
rehype-autolink-headings; mermaid code blocks are routed to a
client-only MermaidBlock that dynamic-imports mermaid on mount.

ManualSidebar (client) reads the typed TOC and highlights the active
chapter via usePathname.

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

* feat(PBI-58): add Manual link to main nav bar

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

---------

Co-authored-by: Claude Opus 4.7 (1M context) <noreply@anthropic.com>
2026-05-07 18:00:10 +02:00
..
adr docs(adr): ADR-0010 — één product = één repo, cross-product planning later via Initiative-laag 2026-05-03 14:44:14 +02:00
api ST-1239: Atomische database-migratie — todos naar ideas + droppen todos-tabel (#132) 2026-05-06 12:25:37 +02:00
architecture docs: fix broken cross-repo links in sprint-execution-modes (PBI-51) (#141) 2026-05-07 13:44:44 +02:00
assets docs: AI-optimized docs restructure (Phases 1–8) (#61) 2026-05-03 03:21:59 +02:00
backlog docs: M12 backlog entry + mcp-integration runbook for idea-jobs (M12 T-517) 2026-05-04 21:45:54 +02:00
decisions docs: AI-optimized docs restructure (Phases 1–8) (#61) 2026-05-03 03:21:59 +02:00
design docs: AI-optimized docs restructure (Phases 1–8) (#61) 2026-05-03 03:21:59 +02:00
diagrams Landing v3: van idee tot pull request + 6 nieuwe screenshots (#127) 2026-05-06 09:05:22 +02:00
docker-smoke Phase 1 — Junk cleanup + front-matter on every doc (#62) 2026-05-03 12:50:35 +02:00
manual PBI-58: Developer manual + in-app /manual page (#148) 2026-05-07 18:00:10 +02:00
patterns docs(dialog): inspector-mode formaliseren in patroon-spec 2026-05-04 08:47:45 +02:00
plans docs: archiveer sprint-pr-worktree state-machines advies (#140) 2026-05-07 13:32:30 +02:00
qa docs: AI-optimized docs restructure (Phases 1–8) (#61) 2026-05-03 03:21:59 +02:00
runbooks feat(M13 PBI-31 T-519b/T-520b): NavBar stand-by badge + quota-check runbook (#119) 2026-05-06 04:34:48 +02:00
specs docs: idea-dialog profile (M12 T-513) 2026-05-04 21:41:00 +02:00
api.md ST-1239: Atomische database-migratie — todos naar ideas + droppen todos-tabel (#132) 2026-05-06 12:25:37 +02:00
architecture.md PBI-50: SPRINT_IMPLEMENTATION single-session sprint runner (Scrum4Me-side) (#139) 2026-05-07 13:05:02 +02:00
backlog.md docs(links): fix broken cross-references after restructure (#63) 2026-05-03 12:52:59 +02:00
erd.svg ST-1239: Atomische database-migratie — todos naar ideas + droppen todos-tabel (#132) 2026-05-06 12:25:37 +02:00
functional.md docs: AI-optimized docs restructure (Phases 1–8) (#61) 2026-05-03 03:21:59 +02:00
glossary.md docs: AI-optimized docs restructure (Phases 1–8) (#61) 2026-05-03 03:21:59 +02:00
INDEX.md PBI-58: Developer manual + in-app /manual page (#148) 2026-05-07 18:00:10 +02:00
md3-color-scheme.md docs: AI-optimized docs restructure (Phases 1–8) (#61) 2026-05-03 03:21:59 +02:00
obsidian-authoring.md docs: AI-optimized docs restructure (Phases 1–8) (#61) 2026-05-03 03:21:59 +02:00
pbi-dialog.md Phase 1 — Junk cleanup + front-matter on every doc (#62) 2026-05-03 12:50:35 +02:00
personas.md docs: AI-optimized docs restructure (Phases 1–8) (#61) 2026-05-03 03:21:59 +02:00
product-backlog.md docs: AI-optimized docs restructure (Phases 1–8) (#61) 2026-05-03 03:21:59 +02:00
realtime-smoke.md Phase 1 — Junk cleanup + front-matter on every doc (#62) 2026-05-03 12:50:35 +02:00
story-dialog.md Phase 1 — Junk cleanup + front-matter on every doc (#62) 2026-05-03 12:50:35 +02:00
task-dialog.md Phase 1 — Junk cleanup + front-matter on every doc (#62) 2026-05-03 12:50:35 +02:00
test-plan.md docs: AI-optimized docs restructure (Phases 1–8) (#61) 2026-05-03 03:21:59 +02:00