docs(tanstack): update guides for v7 #7258
Conversation
* `prisma-client-js` deprecated * chore: empty commit * broken link updated
* added env vars section to various pages * minor coderabbit updates * verbose removed * test removed redirect list * removed quickstart addition * converted quickstarts back
* middleware deleted * more middleware removed * more middleware removed * coderabbit changes
|
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 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. 📒 Files selected for processing (1)
WalkthroughThis 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 Changes
Estimated code review effort🎯 2 (Simple) | ⏱️ ~15 minutes
Possibly related PRs
Pre-merge checks✅ Passed checks (3 passed)
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 |
Dangerous URL checkNo absolute URLs to prisma.io/docs found. |
Redirect checkThis PR probably requires the following redirects to be added to static/_redirects:
|
Deploying docs with
|
| 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 |
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
There was a problem hiding this comment.
Actionable comments posted: 3
Caution
Some comments are outside the diff and can’t be posted inline due to platform limitations.
⚠️ Outside diff range comments (1)
content/800-guides/160-tanstack-start.mdx (1)
141-164: ---Fix file path inconsistency across three code blocks.
Verification confirms the critical inconsistency you identified. The file at lines 141–164 correctly uses
src/routes/index.tsx, establishing the guide's structure pattern. However, the subsequent three code blocks deviate:
- Line 168: Should be
src/routes/index.tsx(currentlyapp/routes/index.tsx)- Line 197: Should be
src/routes/index.tsx(currentlyapp/routes/index.tsx)- Line 232: Should be
src/routes/index.tsx(currentlyapp/routes/index.tsx)This inconsistency will lead developers astray—they'll attempt to create files in the wrong directory structure. Update all three blocks to align with the established
src/pattern:- ```typescript file=app/routes/index.tsx + ```typescript file=src/routes/index.tsx
📜 Review details
Configuration used: Path: .coderabbit.yaml
Review profile: CHILL
Plan: Pro
📒 Files selected for processing (1)
content/800-guides/160-tanstack-start.mdx(5 hunks)
🧰 Additional context used
🧠 Learnings (2)
📚 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
📚 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
🪛 LanguageTool
content/800-guides/160-tanstack-start.mdx
[grammar] ~30-~30: Ensure spelling is correct
Context: ...Would you like to use Tailwind CSS? No - Selecte Toolchain None - *Select deployment a...
(QB_NEW_EN_ORTHOGRAPHY_ERROR_IDS_1)
[grammar] ~80-~80: Ensure spelling is correct
Context: ...e @default(now()) } ``` This creates a Todod model that will be pushed to the databa...
(QB_NEW_EN_ORTHOGRAPHY_ERROR_IDS_1)
⏰ 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). (2)
- GitHub Check: Check internal links
- GitHub Check: Cloudflare Pages
🔇 Additional comments (1)
content/800-guides/160-tanstack-start.mdx (1)
66-66: Update generator output path to align with src/ structure.The generator output path specifies
../app/generated/prisma, but the guide promotes a src/ project structure (as shown in line 116:src/db.ts). This is inconsistent. Verify the correct output path matches the new structure, likely../src/generated/prisma.
| ### 2.2. Configure the Prisma Client generator | ||
|
|
||
| To get access to the variables in the `.env` file, they can either be loaded by your runtime, or by using `dotenv`. | ||
| Include an import for `dotenv` at the top of the `prisma.config.ts` | ||
|
|
||
| ```ts | ||
| //add-start | ||
| import 'dotenv/config' | ||
| //add-end | ||
| import { defineConfig, env } from 'prisma/config'; | ||
| export default defineConfig({ | ||
| schema: 'prisma/schema.prisma', | ||
| migrations: { | ||
| path: 'prisma/migrations', | ||
| }, | ||
| engine: 'classic', | ||
| datasource: { | ||
| url: env('DATABASE_URL'), | ||
| }, | ||
| }); | ||
| ``` | ||
|
|
||
| ### 2.4. Configure the Prisma Client generator | ||
|
|
||
| Now, run the following command to create the database tables and generate the Prisma Client: | ||
| Now, run the following command to create the database tables: | ||
|
|
||
| ```terminal | ||
| npx prisma migrate dev --name init | ||
| npm run db:seed -- --name init | ||
| ``` |
There was a problem hiding this comment.
Resolve section numbering gap and title mismatch.
Two issues here:
- Section numbering: Line 89 shows "### 2.5. Seed the database", but this should be "### 2.3" (the numbering jumps from 2.2 to 2.5, skipping 2.3 and 2.4).
- Section title mismatch: Line 82's title says "Configure the Prisma Client generator", but the content (lines 84–88) describes creating database tables with
npm run db:seed -- --name init. The section title should reflect what's actually being done.
🤖 Prompt for AI Agents
In content/800-guides/160-tanstack-start.mdx around lines 82–89, the heading at
line 82 ("Configure the Prisma Client generator") does not match the content
(running npm run db:seed to create tables) and the next heading at line 89 is
mis-numbered as "### 2.5. Seed the database"; change the line 82 heading to a
title that matches the action (e.g., "### 2.2. Seed / Create database tables"),
rename the heading currently numbered "2.5" to "### 2.3. Seed the database", and
then verify and adjust subsequent section numbers to be sequential so there are
no skipped numbers.
Co-authored-by: coderabbitai[bot] <136622811+coderabbitai[bot]@users.noreply.github.com>
Co-authored-by: coderabbitai[bot] <136622811+coderabbitai[bot]@users.noreply.github.com>
aidankmcalister
force-pushed
the
prisma-7
branch
from
d68abc3 to
e92f2a3
Compare
Needs TanStack/create-tsrouter-app#232 before it can be merged
Summary by CodeRabbit
Documentation