docs: Add Tanstack Start start quickstart guide #40887
Conversation
|
The latest updates on your projects. Learn more about Vercel for GitHub.
|
|
This pull request has been ignored for the connected project Preview Branches by Supabase. |
WalkthroughThree files updated to add TanStack Start as a new framework quickstart option. A navigation menu entry, a new quickstart guide file with seven setup steps, and a quickstarts array entry were added to surface this option across the documentation. Changes
Estimated code review effort🎯 1 (Trivial) | ⏱️ ~8 minutes
Poem
Pre-merge checks and finishing touches❌ Failed checks (1 warning)
✅ Passed checks (2 passed)
✨ Finishing touches
🧪 Generate unit tests (beta)
Comment |
There was a problem hiding this comment.
Again I just made a small change to introduce updates
There was a problem hiding this comment.
Actionable comments posted: 1
🧹 Nitpick comments (1)
apps/docs/content/guides/getting-started/quickstarts/tanstack.mdx (1)
113-136: Query implementation is correct for a quickstart.The code properly uses TanStack Router's loader pattern and optional chaining provides basic safety. For production use, consider adding error handling to the loader function.
For production code, consider adding error handling:
loader: async () => { const { data: instruments, error } = await supabase.from('instruments').select() if (error) throw error return { instruments } },
📜 Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro
📒 Files selected for processing (3)
apps/docs/components/Navigation/NavigationMenu/NavigationMenu.constants.ts(1 hunks)apps/docs/content/guides/getting-started/quickstarts/tanstack.mdx(1 hunks)apps/docs/features/command/Quickstarts.tsx(1 hunks)
🧰 Additional context used
🧠 Learnings (1)
📚 Learning: 2025-12-11T02:39:49.745Z
Learnt from: CR
Repo: supabase/supabase PR: 0
File: .cursor/rules/docs-test-requirements.mdc:0-0
Timestamp: 2025-12-11T02:39:49.745Z
Learning: Applies to apps/docs/**/*.{test,spec}.ts : Before running tests in the docs application, check Supabase status using `pnpm supabase status`. If Supabase is not running, start it with `pnpm supabase start`. Reset the database with `pnpm supabase db reset --local` to ensure clean state. Run tests using `pnpm run -F docs test:local:unwatch` (without watch mode)
Applied to files:
apps/docs/content/guides/getting-started/quickstarts/tanstack.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). (2)
- GitHub Check: build
- GitHub Check: typecheck
🔇 Additional comments (5)
apps/docs/features/command/Quickstarts.tsx (1)
38-41: LGTM! TanStack Start quickstart entry added correctly.The new quickstart entry follows the established pattern and is consistent with other framework entries in the array.
apps/docs/components/Navigation/NavigationMenu/NavigationMenu.constants.ts (1)
374-377: LGTM! Navigation entry added correctly.The new TanStack Start entry is properly formatted and positioned within the Framework Quickstarts section, with a URL that matches the quickstart command entry.
apps/docs/content/guides/getting-started/quickstarts/tanstack.mdx (3)
1-6: LGTM! Frontmatter is well-structured.The metadata is properly formatted with clear title and subtitle that align with the quickstart guide pattern.
92-99: LGTM! Supabase client initialization is correct.The code properly uses Vite's
import.meta.envto access environment variables, which is the correct approach for TanStack Start applications.
162-164: The URL paths in the "Next steps" section are correct and consistent with the documentation structure.All quickstart guides (tanstack, nextjs, reactjs, sveltekit) consistently use the
/docs/guides/...format for internal documentation links, which matches the actual URL structure of the Supabase documentation site (supabase.com/docs/guides/...). No changes needed.
| <ProjectConfigVariables variable="url" /> | ||
| <ProjectConfigVariables variable="publishable" /> | ||
| <ProjectConfigVariables variable="anon" /> |
There was a problem hiding this comment.
Remove redundant variable declaration.
Line 62 declares an anon variable, but it's not used in the .env file (lines 71-72) or in the client initialization (lines 96-97). The "anon" key and "publishable" key refer to the same Supabase credential. Either remove line 62 or clarify that these are interchangeable terms.
Apply this diff to remove the redundant line:
<ProjectConfigVariables variable="url" />
<ProjectConfigVariables variable="publishable" />
- <ProjectConfigVariables variable="anon" />📝 Committable suggestion
‼️ IMPORTANT
Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation. Thoroughly test & benchmark the code to ensure it meets the requirements.
| <ProjectConfigVariables variable="url" /> | |
| <ProjectConfigVariables variable="publishable" /> | |
| <ProjectConfigVariables variable="anon" /> | |
| <ProjectConfigVariables variable="url" /> | |
| <ProjectConfigVariables variable="publishable" /> |
🤖 Prompt for AI Agents
In apps/docs/content/guides/getting-started/quickstarts/tanstack.mdx around
lines 60 to 62, the ProjectConfigVariables variable="anon" declaration is
redundant; remove the entire line declaring anon (line 62) so only url and
publishable remain, and optionally add a brief parenthetical note elsewhere
clarifying that "publishable" and "anon" refer to the same Supabase credential
if you want to explain terminology consistency.
I have read the CONTRIBUTING.md file.
YES
What kind of change does this PR introduce?
Adds a Tanstack Start quickstart guide.
Summary by CodeRabbit
✏️ Tip: You can customize this high-level summary in your review settings.