TanStack / TanStack/router

docs(router): explain Webpack SPA fallback configuration

Open
#7,786 0 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

Goal

Document the Webpack settings required for client-side routing to work on direct loads and refreshes.

Scope

  • Explain devServer.historyApiFallback for serving the application shell on nested routes.
  • Explain output.publicPath, including how deployments under a subpath need their actual public base.
  • Keep the maintained React and Solid Webpack quickstarts aligned with the guide.
  • Add Webpack E2E coverage for a direct load or refresh at a nested route.

Related Work

This continues the documentation work from #4677

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

Start with the maintained React and Solid Webpack quickstarts and the existing routing documentation, then locate the Webpack E2E setup. Document historyApiFallback and output.publicPath, including subpath deployments, and add coverage for a direct load or refresh at a nested route. Done means the guide and both quickstarts agree and the E2E scenario passes.

Written by the indexing model from the issue text.

Assessment

Tech stack
react, typescript, webpack
Domain
documentation, frontend, testing
Issue type
Documentation
Difficulty
3/5
Estimated time
1-2 days
Activity status
Quiet
Clarity
Mostly clear
Newbie friendliness
68/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.