TanStack / TanStack/router

[docs] Outdated ISR guide?

Open Beginner friendly
#7,580 2 comments 0 reactions 0 assignees View on GitHub

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:

https://github.com/TanStack/router/blob/689d88e04c48ec76a18453ab8b82d8d58f2668b6/packages/start-plugin-core/src/schema.ts#L270-L284

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

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. 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

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.