[docs] Outdated ISR guide?
Nobody has claimed this yet.
- Dominant language
- TypeScript
- Stars
- 15.1k
- Forks
- 1.9k
- Avg merge
- 1d 20h
- Merged PRs (30d)
- 143
Description
Which project does this relate to?
Start
Describe the bug
I tried to implement ISG following the ISG guide, and it refers to prerender.routes option in tanstackStart() all the time:
import { tanstackStart } from '@tanstack/react-start/plugin/vite'
import { defineConfig } from 'vite'
export default defineConfig({
plugins: [
tanstackStart({
prerender: {
routes: ['/blog', '/blog/posts/*'],
crawlLinks: true,
},
}),
],
})
This seems wrong, because prerender schema doesn't have a routes field:
Should the ISG guide document the prerender.filter option instead?
Complete minimal reproducer
https://tanstack.com/start/latest/docs/framework/react/guide/isr
Steps to Reproduce the Bug
Check out the ISG Guide
Expected behavior
Correct configuration is documented
Screenshots or Videos
No response
Platform
N/A
Additional context
No response
Contributor guide
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Research direction
Open the linked ISG guide and compare its prerender.routes examples with the prerender schema linked in the issue. Update the guide so its configuration matches the supported option, then verify that the documented example is valid and the expected behavior is clear.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- react, typescript
- Domain
- documentation
- Issue type
- Documentation
- Difficulty
- 2/5
- Estimated time
- 1-3 hours
- Activity status
- Quiet
- Clarity
- Clearly specified
- Newbie friendliness
- 65/100