Skip to content

docs(fumadocs): document build pipeline and dependency guards#154

Draft
tembo[bot] wants to merge 1 commit into
mainfrom
tembo/docs-fumadocs-build-guards
Draft

docs(fumadocs): document build pipeline and dependency guards#154
tembo[bot] wants to merge 1 commit into
mainfrom
tembo/docs-fumadocs-build-guards

Conversation

@tembo

@tembo tembo Bot commented Jul 7, 2026

Copy link
Copy Markdown
Contributor

Summary

Following the merge of #152 (which unified lucide-react and added two build-time guards after a fumadocs-core peer split took production down), the docs-app README had no coverage of the build itself. It documents the Notra blog pipeline in depth but never explained what bun run build actually does or why the new guards exist. This PR fills that gap.

The invariant already has an agent-oriented note in AGENTS.md; this adds the developer-facing reference in apps/fumadocs/README.md, the natural home for docs-app build docs — no redundant page.

Docs added/updated

apps/fumadocs/README.md — new Build pipeline section (placed after the dev-server intro, before the Notra section):

  • A table of the five ordered bun run build steps and what each does, with a note that CI runs the same build via release:ci against the frozen lockfile.
  • A Why the dependency guards exist subsection explaining the two-fumadocs-core-instances → two-React-contexts → FrameworkProvider hydration crash, why the build stays green, and the lucide-react peer-of-fumadocs-core trigger from the 2026-07-07 incident.
  • Usage and fix guidance for both guards, including the "bump fumadocs/lucide-react together" rule and check-client-bundle.ts's explicit-directory invocation.

Codepaths covered

  • apps/fumadocs/package.json — the build script and its step order.
  • apps/fumadocs/scripts/check-module-identity.ts — pre-build singleton-identity guard (fumadocs-core, react, react-dom, @tanstack/react-router, lucide-react).
  • apps/fumadocs/scripts/check-client-bundle.ts — post-build framework-context duplication backstop.
  • apps/fumadocs/scripts/fetch-notra-posts.ts and ensure-root-index.ts — the remaining build steps.

Key knowledge gaps addressed

  • Why bun run build is more than vite build, and what fails the build.
  • Why a green build could still ship a site-wide hydration crash, and how the guards close that hole.
  • How to diagnose and fix a singleton split or bundle duplication (verified against each script's resolution logic, marker string, and error messages — no fabricated behavior).

Documentation-only; no source or config changes.


Want tembo to make any changes? Add a comment with @tembo and i'll get back to work!

View on Tembo View Agent Settings View on automation

@tembo tembo Bot added the tembo Pull request created by Tembo label Jul 7, 2026
@vercel

vercel Bot commented Jul 7, 2026

Copy link
Copy Markdown

The latest updates on your projects. Learn more about Vercel for GitHub.

Project Deployment Actions Updated (UTC)
email-sdk-fumadocs Ready Ready Preview, Comment Jul 7, 2026 5:45pm

Request Review

@tembo tembo Bot requested a review from leoisadev1 July 7, 2026 17:44
@tembo

tembo Bot commented Jul 7, 2026

Copy link
Copy Markdown
Contributor Author

Requesting review from @leoisadev1 who has experience with the following files modified in this PR:

  • apps/fumadocs/README.md

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

tembo Pull request created by Tembo

Projects

None yet

Development

Successfully merging this pull request may close these issues.

0 participants