docs(start): fix ISR guide using non-existent prerender.routes option#7624
docs(start): fix ISR guide using non-existent prerender.routes option#7624rumitvn wants to merge 1 commit into
prerender.routes option#7624Conversation
The ISR guide configured prerendering via prerender.routes, which is not a field on the prerender schema. Replace it with the supported pages array (entry paths) plus prerender.crawlLinks to discover dynamic routes, matching the static-prerendering guide and start-plugin-core schema. Closes TanStack#7580
|
No actionable comments were generated in the recent review. 🎉 ℹ️ Recent review info⚙️ Run configurationConfiguration used: defaults Review profile: CHILL Plan: Pro Run ID: 📒 Files selected for processing (1)
📝 WalkthroughWalkthroughThe ISR documentation guide is updated to correct outdated configuration examples. Four parallel code samples—Vite and Rsbuild variants appearing in two separate sections—now use the valid ChangesISR Guide Documentation Update
Estimated code review effort🎯 1 (Trivial) | ⏱️ ~3 minutes Suggested labels
Poem
🚥 Pre-merge checks | ✅ 5✅ Passed checks (5 passed)
✏️ Tip: You can configure your own custom pre-merge checks in the settings. ✨ Finishing Touches🧪 Generate unit tests (beta)
Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out. Comment |
Closes #7580
Problem
The ISR guide configures prerendering with a
prerender.routesarray:routesis not a field on the prerender schema (start-plugin-core/src/schema.ts— top-levelprerenderonly hasenabled,concurrency,filter,failOnError,autoStaticPathsDiscovery,maxRedirectsplus the sharedpagePrerenderOptionsSchemafields). Following the guide produces an invalid config.Fix
Replace
prerender.routeswith the supportedpagesarray (entry paths) plusprerender.crawlLinks, which discovers and prerenders the linked dynamic routes — matching the Static Prerendering guide and the schema:Applied to all four occurrences (Vite + Rsbuild tabs, in both the time-based and "combine with static prerendering" sections). Docs-only change.
Summary by CodeRabbit
prerendersetup options, includingenabled: true,crawlLinks: true, and explicit page configuration, replacing the previous route-based approach.