Various docs improvements #2456
Conversation
|
WalkthroughThis PR updates documentation across multiple files. It adds notes and a new “Using with Supabase Supavisor” section (duplicated in two places) to the Prisma extension docs, including environment variable guidance and port details. It reorganizes the docs index to move an example from “Example projects” to “Python guides.” The introduction page is restructured with new and renamed cards, new sections, and added extension entries. The “Wait for token” doc receives wording clarifications and a formatting fix. No code or public API changes are included. Estimated code review effort🎯 3 (Moderate) | ⏱️ ~25 minutes ✨ Finishing Touches🧪 Generate unit tests
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. 🪧 TipsChatThere are 3 ways to chat with CodeRabbit:
SupportNeed help? Create a ticket on our support page for assistance with any issues or questions. CodeRabbit Commands (Invoked using PR/Issue comments)Type Other keywords and placeholders
CodeRabbit Configuration File (
|
![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)
docs/wait-for-token.mdx (1)
32-40: Standardize token vs tokenId in examples.Examples mix
tokenId,token, andtoken.url. Use eithertoken.ideverywhere or rely on structural typing by passingtoken(object withid) consistently. The current snippets referencetokenIdwithout defining it.Apply:
-const result = await wait.forToken<ApprovalToken>(tokenId); +const result = await wait.forToken<ApprovalToken>(token.id);-const prediction = await wait.forToken<Prediction>(token).unwrap(); +const prediction = await wait.forToken<Prediction>(token.id).unwrap();-const approval = await wait.forToken<ApprovalToken>(tokenId).unwrap(); +const approval = await wait.forToken<ApprovalToken>(token.id).unwrap();-const result = await wait.forToken<ApprovalToken>(tokenId); +const result = await wait.forToken<ApprovalToken>(token.id);-const token = await wait.retrieveToken(tokenId); +const token = await wait.retrieveToken(tokenId /* or token.id if you have the token */);If you prefer passing the object, add a note that
wait.forTokenacceptsstring | { id: string }and that the full token object is acceptable because it has anidfield.Also applies to: 72-74, 306-311, 318-325, 488-493
🧹 Nitpick comments (4)
docs/wait-for-token.mdx (2)
3-3: Good clarification in the description.Explicitly naming “waitpoint tokens” improves discoverability. Consider using the same term consistently throughout the page (“waitpoint tokens” vs “wait tokens”) for polish.
53-54: Clarify body shape difference between the callback URL and the API endpoint.Nice to call out it’s an HTTP callback. Add a one‑liner that the token URL expects the raw JSON payload as the output, whereas the management API endpoint expects
{ "output": ... }, to prevent confusion.Apply:
-Or you can make an HTTP POST request to the `url` it returns. This is an HTTP callback: +Or you can make an HTTP POST request to the `url` it returns. This is an HTTP callback: +When posting to the token `url`, the request body itself becomes the token output. +When using the management API endpoint, wrap the payload in `{ "output": ... }`.docs/config/extensions/prismaExtension.mdx (1)
140-141: Scope and tighten the connection limit guidance.Good tip. Minor edits: make it directive, and scope it to pooled/Supavisor URLs to avoid implying it’s needed on direct DB URLs.
-If you're experiencing database connection issues during deployment, you may need to add `?connection_limit=1` to your `DATABASE_URL` to limit the number of concurrent connections during the build process. +If you encounter connection issues during deployment, append `?connection_limit=1` to your pooled `DATABASE_URL` (Supavisor/PgBouncer) to limit concurrent connections during the build.docs/guides/frameworks/supabase-authentication.mdx (1)
79-85: Optional: Align env var naming with Prisma docs.If you want to match Prisma docs verbatim, consider
DIRECT_URLinstead ofDATABASE_URL_UNPOOLED. Not required—your currentdirectUrlEnvVarNameworks.-prismaExtension({ - schema: "prisma/schema.prisma", - directUrlEnvVarName: "DATABASE_URL_UNPOOLED", -}), +prismaExtension({ + schema: "prisma/schema.prisma", + directUrlEnvVarName: "DIRECT_URL", +}),Prisma uses
DIRECT_URL+DATABASE_URL. (prismagraphql.com)
📜 Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro
💡 Knowledge Base configuration:
- MCP integration is disabled by default for public repositories
- Jira integration is disabled by default for public repositories
- Linear integration is disabled by default for public repositories
You can enable these sources in your CodeRabbit configuration.
⛔ Files ignored due to path filters (1)
docs/images/intro-mcp.jpgis excluded by!**/*.jpg
📒 Files selected for processing (5)
docs/config/extensions/prismaExtension.mdx(1 hunks)docs/docs.json(1 hunks)docs/guides/frameworks/supabase-authentication.mdx(1 hunks)docs/introduction.mdx(4 hunks)docs/wait-for-token.mdx(3 hunks)
🧰 Additional context used
🧠 Learnings (2)
📚 Learning: 2025-07-18T17:49:24.468Z
Learnt from: CR
PR: triggerdotdev/trigger.dev#0
File: .github/copilot-instructions.md:0-0
Timestamp: 2025-07-18T17:49:24.468Z
Learning: Applies to internal-packages/database/**/*.{ts,tsx} : We use prisma in internal-packages/database for our database interactions using PostgreSQL
Applied to files:
docs/guides/frameworks/supabase-authentication.mdx
📚 Learning: 2025-08-18T10:07:17.368Z
Learnt from: CR
PR: triggerdotdev/trigger.dev#0
File: .cursor/rules/writing-tasks.mdc:0-0
Timestamp: 2025-08-18T10:07:17.368Z
Learning: Applies to trigger.config.ts : Declare build options and extensions (external, jsx, conditions, extensions) via the build block in trigger.config.ts rather than custom scripts
Applied to files:
docs/introduction.mdx
🪛 LanguageTool
docs/config/extensions/prismaExtension.mdx
[style] ~140-~140: You have already used this phrasing in nearby sentences. Consider replacing it to add variety to your writing.
Context: ...ction issues during deployment, you may need to add ?connection_limit=1 to your `DATA...
(REP_NEED_TO_VB)
⏰ 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). (1)
- GitHub Check: Analyze (javascript-typescript)
🔇 Additional comments (5)
docs/docs.json (1)
355-360: Nav entry correctly moved—no duplicates and MDX file present.docs/introduction.mdx (4)
77-87: Nice additions: “Wait for token” and “Build extensions”.These connect well to the updated wait-for-token docs and extensions overview.
108-179: LGTM on the example grid.Links appear aligned with entries in docs.json. Spot-check passes once anchors are verified.
13-18: No broken link—example-tasksanchor is present
The heading “## Example tasks” at line 61 indocs/guides/introduction.mdxgenerates the#example-tasksanchor.
96-99: Extension docs present. Verified thatdocs/config/extensions/playwright.mdxanddocs/config/extensions/lightpanda.mdxexist, so the links will not 404.
There was a problem hiding this comment.
Actionable comments posted: 0
🧹 Nitpick comments (3)
docs/config/extensions/prismaExtension.mdx (3)
140-143: Tighten phrasing and scope to “pooled during build”.Minor copy edit and clarity that this tip applies to the pooled DATABASE_URL used in the build step, not to all runtime URLs.
-If you're experiencing database connection issues during deployment, you may need to add `?connection_limit=1` to your `DATABASE_URL` to limit the number of concurrent connections during the build process. +If you hit connection limits during deployment builds, add `?connection_limit=1` to the pooled `DATABASE_URL` used in the build to temporarily reduce concurrent connections.
146-147: Port-mode guidance is correct; consider minor wording polish.The Transaction/Session mode split across 6543/5432 as of February 28, 2025 matches Supabase guidance. Suggest small copy edit for tone and date format.
-When using Prisma with Supabase's Supavisor pooler, use a pooled URL for Prisma Client and a session/direct URL for schema operations to avoid prepared statement conflicts. As of Feb 28, 2025, port 6543 runs Transaction Mode only; use port 5432 for Session Mode. +When using Prisma with Supabase’s Supavisor, use a pooled URL for Prisma Client and a Session Mode URL for schema operations to avoid prepared‑statement conflicts. As of February 28, 2025, port 6543 is Transaction Mode only; use port 5432 for Session Mode.Evidence: Supabase announcement and docs on 6543 (transaction) vs 5432 (session). (github.com, supabase.com)
163-166: Avoid “session/direct” wording; prefer the exact mode name.“Direct” can be misread as bypassing Supavisor. Recommend naming the exact mode.
-Use the pooled connection (port 6543, Transaction Mode) for regular Prisma Client queries. Use the - session/direct connection (port 5432, Session Mode) for migrations and other schema operations. +Use the pooled connection (Transaction Mode, port 6543) for regular Prisma Client queries. Use the + Session Mode connection (port 5432) for migrations and other schema operations.
📜 Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro
💡 Knowledge Base configuration:
- MCP integration is disabled by default for public repositories
- Jira integration is disabled by default for public repositories
- Linear integration is disabled by default for public repositories
You can enable these sources in your CodeRabbit configuration.
📒 Files selected for processing (1)
docs/config/extensions/prismaExtension.mdx(1 hunks)
🧰 Additional context used
🧠 Learnings (1)
📚 Learning: 2025-07-18T17:49:24.468Z
Learnt from: CR
PR: triggerdotdev/trigger.dev#0
File: .github/copilot-instructions.md:0-0
Timestamp: 2025-07-18T17:49:24.468Z
Learning: Applies to internal-packages/database/**/*.{ts,tsx} : We use prisma in internal-packages/database for our database interactions using PostgreSQL
Applied to files:
docs/config/extensions/prismaExtension.mdx
🪛 LanguageTool
docs/config/extensions/prismaExtension.mdx
[style] ~140-~140: You have already used this phrasing in nearby sentences. Consider replacing it to add variety to your writing.
Context: ...ction issues during deployment, you may need to add ?connection_limit=1 to your `DATA...
(REP_NEED_TO_VB)
⏰ 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). (1)
- GitHub Check: Analyze (javascript-typescript)
🔇 Additional comments (2)
docs/config/extensions/prismaExtension.mdx (2)
149-153: Config snippet LGTM.Using directUrlEnvVarName for migrations/schema ops is the right pattern with Prisma Migrate. No changes needed. (trigger.mintlify.dev)
156-161: Connection string examples align with Supabase format; keep params intentional.
- Username including project ref (postgres.[PROJECT_REF]) and Supavisor host shape look correct.
?pgbouncer=trueon the pooled URL is recommended with Supavisor to disable prepared statements; omitting it on the Session/Direct URL is appropriate.If you want to double‑check against current Supabase docs (they evolve), verify these specifics:
- Supavisor username/host pattern
- Recommendation to use
pgbouncer=trueon pooled connectionsReferences: Supabase troubleshooting and Prisma docs. (supabase.com, github.com, prisma.io)
No description provided.