docs(): update tanstack start guide #7291
Conversation
Dangerous URL checkNo absolute URLs to prisma.io/docs found. |
WalkthroughThis PR comprehensively rewrites the TanStack Start guide, reducing setup time from 10 to 5 minutes by replacing manual scaffolding with Changes
Estimated code review effort🎯 3 (Moderate) | ⏱️ ~20 minutes
Possibly related PRs
Pre-merge checks❌ Failed checks (1 inconclusive)
✅ Passed checks (2 passed)
Tip 📝 Customizable high-level summaries are now available in beta!You can now customize how CodeRabbit generates the high-level summary in your pull requests — including its content, structure, tone, and formatting.
Example instruction:
Note: This feature is currently in beta for Pro-tier users, and pricing will be announced later. 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. Comment |
Redirect checkThis PR probably requires the following redirects to be added to static/_redirects:
|
Deploying docs with
|
| Latest commit: |
8b219dc
|
| Status: | ✅ Deploy successful! |
| Preview URL: | https://b788f792.docs-51g.pages.dev |
| Branch Preview URL: | https://docs-tanstack-updates.docs-51g.pages.dev |
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
There was a problem hiding this comment.
Actionable comments posted: 0
🧹 Nitpick comments (2)
content/800-guides/160-tanstack-start.mdx (2)
59-59: Align headings with sentence case per documentation guidelines.Per the repository's style guide, headings should use sentence case (capitalizing only the first word and product names), not title case. Adjust:
- Line 59: "Define your Prisma Schema" → "Define your Prisma schema"
- Line 82: "Configure the Prisma Client generator" → Consider if "Client" should be lowercase here (compare to other headings)
- Line 111: "The Prisma Client" → "The Prisma client" (unless treating "Prisma Client" as a full product name exception)
For consistency, review whether "Prisma Client" is treated as a unified product name (like "Prisma ORM") or if "client" should be lowercase in these contexts.
Based on learnings
Also applies to: 82-82, 111-111
35-35: Fix typo in database provider name."Prisma PostgresSQL" should be "Prisma PostgreSQL" (double-S is incorrect). This appears in the interactive prompt example.
📜 Review details
Configuration used: Path: .coderabbit.yaml
Review profile: CHILL
Plan: Pro
⛔ Files ignored due to path filters (1)
package-lock.jsonis excluded by!**/package-lock.json
📒 Files selected for processing (1)
content/800-guides/160-tanstack-start.mdx(6 hunks)
🧰 Additional context used
🧠 Learnings (2)
📚 Learning: 2025-10-08T16:23:00.388Z
Learnt from: aidankmcalister
Repo: prisma/docs PR: 7165
File: content/800-guides/550-test-guide.mdx:85-90
Timestamp: 2025-10-08T16:23:00.388Z
Learning: For .mdx files in the prisma/docs repository: All headings and titles should use sentence case (e.g., "Getting started with Prisma ORM", "Best practices for authentication"), not title case. Exception: Always preserve exact casing for product names including "Prisma Postgres", "Prisma", "Prisma ORM", and "Prisma Data Platform".
Applied to files:
content/800-guides/160-tanstack-start.mdx
📚 Learning: 2025-10-09T21:32:50.340Z
Learnt from: aidankmcalister
Repo: prisma/docs PR: 7167
File: content/900-ai/prompts/astro.mdx:84-84
Timestamp: 2025-10-09T21:32:50.340Z
Learning: The `npx prisma init` command supports the following flags: `--db` (shorthand for `--datasource-provider prisma+postgres`), `--output` (specifies output location for generated client), `--generator-provider` (defines the generator provider), `--datasource-provider`, `--url`, `--preview-feature`, and `--with-model`. These are documented valid CLI options for Prisma init command.
Applied to files:
content/800-guides/160-tanstack-start.mdx
⏰ Context from checks skipped due to timeout of 90000ms. You can increase the timeout in your CodeRabbit configuration to a maximum of 15 minutes (900000ms). (3)
- GitHub Check: Check links
- GitHub Check: Check internal links
- GitHub Check: Cloudflare Pages
🔇 Additional comments (1)
content/800-guides/160-tanstack-start.mdx (1)
82-107: Verify Prisma command sequence and npm script naming.The command sequence in this section is confusing:
- Line 87 (section 2.2):
npm run db:seed -- --name initis described as creating database tables, butdb:seedtypically adds data, not creates schema.- Section 2.3 title says "Seed the database" but contains both
db:generate(line 94) anddb:seed(line 100).- The section titles don't align clearly with what each command does.
This suggests either the commands, section titles, or both need correction. TanStack Start's
npm createscaffolding might use non-standard npm script names, so I need to verify this sequence is accurate.Can you confirm that:
npm run db:seed -- --name initis the correct command to create/push the database schema (notnpx prisma db pushornpx prisma migrate dev --name init)?- The section titles accurately describe what each command does?
- The ordering (seed-with-init → generate → seed) is the intended workflow for TanStack Start's Prisma setup?
If these are custom TanStack Start npm scripts with non-obvious names, consider adding inline comments in the code blocks to clarify (e.g.,
# Creates database schemabefore thedb:seedline).
🍈 Lychee Link Check Report
📊 Results Overview
Errors per inputErrors in 200-orm/500-reference/250-error-reference.mdx
Errors in 800-guides/050-migrate-from-mongoose.mdx
Errors in 800-guides/370-bun.mdx
|
Tanstack start recently updated their prisma integration, this updates the guide to use the latest changes
Summary by CodeRabbit