Skip to content

docs(start): fix ISR guide using non-existent prerender.routes option#7624

Open
rumitvn wants to merge 1 commit into
TanStack:mainfrom
rumitvn:docs/fix-isr-prerender-routes
Open

docs(start): fix ISR guide using non-existent prerender.routes option#7624
rumitvn wants to merge 1 commit into
TanStack:mainfrom
rumitvn:docs/fix-isr-prerender-routes

Conversation

@rumitvn

@rumitvn rumitvn commented Jun 13, 2026

Copy link
Copy Markdown

Closes #7580

Problem

The ISR guide configures prerendering with a prerender.routes array:

tanstackStart({
  prerender: {
    routes: ['/blog', '/blog/posts/*'],
    crawlLinks: true,
  },
})

routes is not a field on the prerender schema (start-plugin-core/src/schema.ts — top-level prerender only has enabled, concurrency, filter, failOnError, autoStaticPathsDiscovery, maxRedirects plus the shared pagePrerenderOptionsSchema fields). Following the guide produces an invalid config.

Fix

Replace prerender.routes with the supported pages array (entry paths) plus prerender.crawlLinks, which discovers and prerenders the linked dynamic routes — matching the Static Prerendering guide and the schema:

tanstackStart({
  prerender: {
    enabled: true,
    crawlLinks: true,
  },
  pages: [{ path: '/blog' }],
})

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

  • Documentation
    • Updated ISR configuration examples for TanStack Start with new prerender setup options, including enabled: true, crawlLinks: true, and explicit page configuration, replacing the previous route-based approach.

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
@coderabbitai

coderabbitai Bot commented Jun 13, 2026

Copy link
Copy Markdown
Contributor

Review Change Stack

No actionable comments were generated in the recent review. 🎉

ℹ️ Recent review info
⚙️ Run configuration

Configuration used: defaults

Review profile: CHILL

Plan: Pro

Run ID: 48c754e3-8a34-4f5a-9e5d-e067cf013811

📥 Commits

Reviewing files that changed from the base of the PR and between a2b9d51 and c8f6d5e.

📒 Files selected for processing (1)
  • docs/start/framework/react/guide/isr.md

📝 Walkthrough

Walkthrough

The 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 prerender schema with enabled: true, crawlLinks: true, and pages: [{ path: '/blog' }] in place of the non-existent routes field.

Changes

ISR Guide Documentation Update

Layer / File(s) Summary
ISR prerender configuration examples
docs/start/framework/react/guide/isr.md
All four code sample blocks are corrected to use the valid prerender schema: enabled: true, crawlLinks: true, and an explicit pages array, replacing the outdated routes property across Vite and Rsbuild examples in two document sections.

Estimated code review effort

🎯 1 (Trivial) | ⏱️ ~3 minutes

Suggested labels

documentation

Poem

📖 A rabbit hops through docs so fine,
Where prerender routes once did align,
Now crawlLinks and pages shine,
The ISR guide's now all divine! 🐰✨

🚥 Pre-merge checks | ✅ 5
✅ Passed checks (5 passed)
Check name Status Explanation
Description Check ✅ Passed Check skipped - CodeRabbit’s high-level summary is enabled.
Title check ✅ Passed The title accurately describes the main change: fixing the ISR guide that incorrectly documented the non-existent prerender.routes option.
Linked Issues check ✅ Passed The PR directly addresses issue #7580 by replacing invalid prerender.routes configuration with the correct approach using enabled: true, crawlLinks: true, and the pages array.
Out of Scope Changes check ✅ Passed All changes are directly related to fixing the ISR documentation as specified in issue #7580; no out-of-scope modifications are present.
Docstring Coverage ✅ Passed No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.

✏️ Tip: You can configure your own custom pre-merge checks in the settings.

✨ Finishing Touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests

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.

❤️ Share

Comment @coderabbitai help to get the list of available commands and usage tips.

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

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

[docs] Outdated ISR guide?

1 participant