docs: document the dev-server OOM workaround for large generations - #808
Merged
wyuc merged 2 commits intoJul 2, 2026
Merged
Conversation
wyuc
approved these changes
Jul 2, 2026
wyuc
left a comment
Contributor
There was a problem hiding this comment.
Accurate and well-scoped — this matches the dev-mode OOM behavior we've seen with large generations (Next dev's internal worker pool, unrelated to Jest/testing), and the heap-sizing caveat plus the production-unaffected note are both correct. Thanks!
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
Adds a "Troubleshooting" section to the Getting Started docs documenting the dev-server out-of-memory crash that occurs when generating large content locally. The note explains the
Jest worker encountered 2 child process exceptions, exceeding retry limitsymptom, clarifies it is a dev-only Next.js worker-fork limitation rather than an OpenMAIC runtime bug, and gives the maintainer's heap-size workaround (NODE_OPTIONS=--max-old-space-size=4096) for both macOS/Linux and Windows PowerShell. The fix was previously only in a single issue comment, so the next local user hitting this crash now has a documented path. This documents the existing dev-only workaround only and does not claim a code fix; production builds are unaffected.Related Issues
Fixes #625
Changes
packages/docs/content/docs/getting-started.mdx, placed after the## Runsection, documenting the dev-server OOM symptom, its root cause (dev-only Next.js worker fork for App Router dynamic routes), and theNODE_OPTIONS=--max-old-space-size=4096workaround for macOS/Linux and Windows PowerShell.Type of Change
Verification
Steps to reproduce / test
packages/docs/content/docs/getting-started.mdx.## Troubleshootingsection renders after## Runand before## Build for production.What you personally verified
pnpm devconvention.Evidence
pnpm check && pnpm lint && npx tsc --noEmit)Checklist
AI was used for assistance.