docs icon indicating copy to clipboard operation
docs copied to clipboard

docs(tanstack): update guides for v7

Open mhartington opened this issue 1 month ago • 4 comments

Needs https://github.com/TanStack/create-tsrouter-app/pull/232 before it can be merged

Summary by CodeRabbit

Documentation

  • Updated TanStack Start guide with an interactive CLI setup experience
  • Replaced static setup instructions with guided Prisma onboarding prompts
  • Simplified example application from complex data models to a basic Todo app
  • Enhanced database connection configuration guidance with interactive workflows
  • Improved route and component integration patterns in tutorial

mhartington avatar Nov 16 '25 01:11 mhartington

[!WARNING]

Rate limit exceeded

@mhartington has exceeded the limit for the number of commits or files that can be reviewed per hour. Please wait 7 minutes and 24 seconds before requesting another review.

⌛ How to resolve this issue?

After the wait time has elapsed, a review can be triggered using the @coderabbitai review command as a PR comment. Alternatively, push new commits to this PR.

We recommend that you space out your commits to avoid hitting the rate limit.

🚦 How do rate limits work?

CodeRabbit enforces hourly rate limits for each developer per organization.

Our paid plans have higher rate limits than the trial, open-source and free plans. In all cases, we re-allow further reviews after a brief timeout.

Please see our FAQ for further information.

📥 Commits

Reviewing files that changed from the base of the PR and between f3bb75bbd59cbc9994c75d582717ed8ac415c5d2 and e5848d407ebf1139a336ed9c0e6d118be2970f4e.

📒 Files selected for processing (1)
  • content/800-guides/160-tanstack-start.mdx (5 hunks)

Walkthrough

This PR updates the TanStack Start guide from a static Posts/Users example to an interactive Todos-focused guide. It replaces scaffolding content with CLI setup prompts, restructures the project layout from app/ to src/, updates the Prisma schema from User/Post models to a simplified Todo model, and adjusts all corresponding imports, routes, loaders, and data-fetching logic.

Changes

Cohort / File(s) Summary
Interactive Setup & CLI Integration
content/800-guides/160-tanstack-start.mdx
Replaces static setup instructions with interactive TanStack Start CLI preview showing project naming, toolchain selection, deployment adapter, and Prisma onboarding prompts. Introduces guided database connection string and configuration flow.
Prisma Schema & Database Configuration
content/800-guides/160-tanstack-start.mdx
Updates Prisma schema from User and Post models to a simplified Todo model with id, title, and createdAt fields. Adjusts generator and datasource configuration; replaces dotenv-centric environment setup with CLI-guided approach.
Route Structure & Import Paths
content/800-guides/160-tanstack-start.mdx
Restructures project layout from app/ to src/. Updates imports from ../lib/prisma to ../db, changes Route export signature to use App component with loader, and updates route path references to match new file organization.
Data Flow & UI Components
content/800-guides/160-tanstack-start.mdx
Modifies loader and server functions to fetch prisma.todo.findMany() instead of posts. Updates UI from "Posts" to "Todos", refactors component data consumption to use Route.useLoaderData() with todos list iteration.

Estimated code review effort

🎯 2 (Simple) | ⏱️ ~15 minutes

  • Verify all import paths (particularly ../db references and src/ structure) remain consistent throughout the guide
  • Validate that Prisma schema changes (Todo model definition) align with the data fetching logic in loaders and server functions
  • Confirm Route/loader configuration in src/routes/index.tsx examples matches the component's expected data structure
  • Ensure all code snippets are syntactically correct and follow TanStack Start patterns

Possibly related PRs

  • prisma/docs#7073 — Updates Prisma generator/provider settings and client import path configurations, which intersects with the schema and import changes in this guide.
  • prisma/docs#7173 — Modifies the same TanStack Start guide section with server-side route loader wiring, though this PR substantially refactors that area with the Todo model and new import paths.

Pre-merge checks

✅ Passed checks (3 passed)
Check name Status Explanation
Description Check ✅ Passed Check skipped - CodeRabbit’s high-level summary is enabled.
Title check ✅ Passed The title accurately reflects the main change: updating TanStack Start documentation to align with v7, including shifts to interactive CLI previews, Prisma schema updates (User/Post to Todo), and new project structure (src/ layout).
Docstring Coverage ✅ Passed No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.

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.

coderabbitai[bot] avatar Nov 16 '25 01:11 coderabbitai[bot]

Dangerous URL check

No absolute URLs to prisma.io/docs found. No local URLs found.

github-actions[bot] avatar Nov 16 '25 01:11 github-actions[bot]

Redirect check

This PR probably requires the following redirects to be added to static/_redirects:

  • This PR does not change any pages in a way that would require a redirect.

github-actions[bot] avatar Nov 16 '25 01:11 github-actions[bot]

Deploying docs with  Cloudflare Pages  Cloudflare Pages

Latest commit: e5848d4
Status: ✅  Deploy successful!
Preview URL: https://2133f5dc.docs-51g.pages.dev
Branch Preview URL: https://v7-tanstack-updates.docs-51g.pages.dev

View logs