Commit graph

2 commits

Author SHA1 Message Date
7d5fb35964 docs(PBI-86): hybride Forgejo-flow gedocumenteerd (T-1008)
Werker-flow docs aangepast naar het hybride model: `origin` is Forgejo,
de worker maakt geen GitHub-PR meer; die ontstaat via een handmatig
getriggerde promote-Action in Forgejo.

- docs/runbooks/forgejo-hybrid-flow.md: nieuw canoniek runbook met
  het flow-diagram, de promote-stap en main-sync.
- CLAUDE.md: stap 1 + stap 8 + Hardstop "Push" verwijzen naar het
  nieuwe runbook.
- AGENTS.md: tabel-rij "Queue leeg" + PBI-86-toelichting.
- docs/runbooks/branch-and-commit.md: intro herschreven (Vercel-cost
  verschuift naar promote-trigger), agent-batch-flow tabel + E2E-
  verificatie + rebase-noot bijgewerkt.
- docs/runbooks/auto-pr-flow.md: DEPRECATED-banner; document blijft als
  historische referentie.
- docs/manual/03-git-workflow.md: rule 3 (push), rule 5 (auto-PR →
  promote) en de merge-conflicts tabel.
- docs/manual/04-mcp-integration.md: mermaid-stap aangepast.
- docs/manual/05-docker.md: GITHUB_TOKEN-beschrijving verduidelijkt
  (optioneel; niet meer nodig voor de worker zelf).
- docs/INDEX.md: regen via npm run docs (113 docs).

npm run verify groen: 924 tests, typecheck clean.

Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com>
2026-05-15 17:35:11 +02:00
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