patch: update docs #7374
patch: update docs #7374
Conversation
Dangerous URL checkNo absolute URLs to prisma.io/docs found. |
Redirect checkThis PR probably requires the following redirects to be added to static/_redirects:
|
WalkthroughAdded documentation for two new Prisma dev subcommands— Changes
Estimated code review effort🎯 2 (Simple) | ⏱️ ~10 minutes
Possibly related PRs
Pre-merge checks❌ Failed checks (1 inconclusive)
✅ Passed checks (2 passed)
Comment |
Deploying docs with
|
| Latest commit: |
d344441
|
| Status: | ✅ Deploy successful! |
| Preview URL: | https://127cc133.docs-51g.pages.dev |
| Branch Preview URL: | https://ankur-docs-patches.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/250-postgres/300-database/550-local-development.mdx (1)
101-122: LGTM! Comprehensive documentation fordev start.The section clearly documents the new
dev startsubcommand with helpful examples showing both exact matches and glob patterns. The progression from simple to complex examples is well-structured.Optional style refinement:
Line 121 could simplify "outside of" to "outside" for more concise phrasing:
-This command enables you to manage Prisma Postgres instances outside of the VS Code extension, allowing for background instance management in your development workflow. +This command enables you to manage Prisma Postgres instances outside the VS Code extension, allowing for background instance management in your development workflow.content/200-orm/500-reference/200-prisma-cli-reference.mdx (1)
883-904: LGTM! Thorough CLI reference documentation.The
dev startsubcommand is well-documented with clear examples demonstrating both exact matches and glob pattern usage. The documentation is consistent with the local development guide.Optional style refinement:
Similar to the local development guide, line 903 could simplify "outside of" to "outside":
-This enables background instance management outside of the VS Code extension. +This enables background instance management outside the VS Code extension.
📜 Review details
Configuration used: Path: .coderabbit.yaml
Review profile: CHILL
Plan: Pro
📒 Files selected for processing (3)
content/200-orm/500-reference/200-prisma-cli-reference.mdx(4 hunks)content/250-postgres/300-database/550-local-development.mdx(3 hunks)static/_redirects(1 hunks)
🧰 Additional context used
🪛 LanguageTool
content/250-postgres/300-database/550-local-development.mdx
[style] ~121-~121: This phrase is redundant. Consider using “outside”.
Context: ...you to manage Prisma Postgres instances outside of the VS Code extension, allowing for bac...
(OUTSIDE_OF)
content/200-orm/500-reference/200-prisma-cli-reference.mdx
[style] ~903-~903: This phrase is redundant. Consider using “outside”.
Context: ... enables background instance management outside of the VS Code extension. ### dev ls L...
(OUTSIDE_OF)
⏰ 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 (9)
static/_redirects (1)
842-842: LGTM! Redirect properly fixes the broken link.The redirect correctly maps the old Accelerate concepts documentation path to the new location, addressing the Linear issue DR-6439 mentioned in the PR description.
content/250-postgres/300-database/550-local-development.mdx (4)
91-100: LGTM! Clear documentation for the detached mode.The section effectively explains the
--detachflag and its use cases for automated workflows. The comparison todocker runprovides helpful context for users familiar with container workflows.
123-132: LGTM! Concise and clear documentation.The
dev lscommand documentation is appropriately brief while conveying all necessary information about listing instances.
153-158: LGTM! Important safety documentation.Adding this note helps users understand the interactive nature of the
stopcommand and why they'll see confirmation prompts. This prevents confusion and aligns with best practices for documenting potentially disruptive operations.
179-184: LGTM! Critical safety documentation.The note appropriately emphasizes the data loss risks associated with the
rmcommand. The mention of "confirmation phrase that hints at the risks involved" properly conveys the seriousness of this operation.content/200-orm/500-reference/200-prisma-cli-reference.mdx (4)
849-849: LGTM! Clear and accurate flag documentation.The
--detachflag is properly documented in the arguments table with an appropriate description highlighting its use cases for automation.
905-914: LGTM! Clean and clear command documentation.The
dev lscommand is appropriately documented, explaining its purpose and output in a concise manner.
935-940: LGTM! Consistent safety documentation.The safety note for the
stopcommand is properly documented here, maintaining consistency with the local development guide. This helps users understand the interactive nature of the command across all documentation.
961-966: LGTM! Essential safety documentation.The safety note for the
rmcommand properly emphasizes the data loss risks and explains the interactive confirmation process. This is critical documentation for a destructive operation.
🍈 Lychee Link Check Report
📊 Results Overview
|
There was a problem hiding this comment.
Actionable comments posted: 0
🧹 Nitpick comments (4)
content/200-orm/500-reference/200-prisma-cli-reference.mdx (3)
934-938: Add clarity to the safety prompt note fordev stop.The note correctly indicates this is an interactive command with safety prompts, but it would be more helpful to explicitly mention that users need to confirm before the action executes. Consider mentioning that this prevents accidental operations, which is already implied but good to state explicitly.
Consider revising to:
:::note The `stop` command is interactive and includes safety prompts to prevent accidental operations. You will be asked to confirm before the instance is stopped. :::
960-964: Clarify the safety confirmation mechanism fordev rm.Similar to the
dev stopnote, this could be more explicit about what "confirmation phrase" means. The current wording "confirmation phrase that hints at the risks involved" is somewhat vague. Does this mean the CLI will ask users to type a specific phrase or confirm with yes/no?Consider clarifying:
:::note The `rm` command is interactive and includes safety prompts to prevent accidental data loss. You will be asked to confirm the action before any data is deleted. :::
902-902: Fix redundant phrase for better style.Line 902 contains "outside of the VS Code extension" which is stylistically redundant. The phrase can be simplified to improve readability.
Apply this diff:
-This enables background instance management outside of the VS Code extension. +This enables background instance management outside the VS Code extension.As per LanguageTool style guidelines, "outside" is preferred over "outside of" in this context.
content/250-postgres/300-database/550-local-development.mdx (1)
111-111: Fix redundant phrase for better style.Similar to the CLI reference file, line 111 contains "outside of the VS Code extension" which should be simplified to improve readability.
Apply this diff:
-This command enables you to manage Prisma Postgres instances outside of the VS Code extension, allowing for background instance management in your development workflow. +This command enables you to manage Prisma Postgres instances outside the VS Code extension, allowing for background instance management in your development workflow.As per LanguageTool style guidelines, "outside" is preferred over "outside of" in this context.
📜 Review details
Configuration used: Path: .coderabbit.yaml
Review profile: CHILL
Plan: Pro
📒 Files selected for processing (2)
content/200-orm/500-reference/200-prisma-cli-reference.mdx(3 hunks)content/250-postgres/300-database/550-local-development.mdx(3 hunks)
🧰 Additional context used
🪛 LanguageTool
content/250-postgres/300-database/550-local-development.mdx
[style] ~111-~111: This phrase is redundant. Consider using “outside”.
Context: ...you to manage Prisma Postgres instances outside of the VS Code extension, allowing for bac...
(OUTSIDE_OF)
content/200-orm/500-reference/200-prisma-cli-reference.mdx
[style] ~902-~902: This phrase is redundant. Consider using “outside”.
Context: ... enables background instance management outside of the VS Code extension. ### dev ls L...
(OUTSIDE_OF)
⏰ 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 (5)
content/200-orm/500-reference/200-prisma-cli-reference.mdx (2)
882-903: Comprehensive documentation fordev startcommand.The documentation clearly explains the glob pattern syntax with progressive examples (single instance, then wildcard). This is well-structured and helpful.
904-912: Well-documenteddev lscommand section.The description is concise and accurate, explaining that the command lists instances with their status and configuration.
content/250-postgres/300-database/550-local-development.mdx (3)
91-121: Well-integrated documentation for background instance management.The new sections on starting and listing instances fit naturally into the local development guide. The contextual explanation ("enables you to manage Prisma Postgres instances outside of the VS Code extension") is helpful for understanding when to use these commands.
143-147: Inconsistency in safety prompt descriptions between files.This file describes the safety mechanism more specifically ("You'll be asked to confirm the action by typing a confirmation phrase") compared to the CLI reference file which only states "includes safety prompts". This level of detail is helpful here in the local development context, but should remain consistent across documentation.
Please verify:
- Does the actual CLI indeed ask users to type a confirmation phrase, or is it a yes/no confirmation?
- Should the CLI reference file (file 1) include the same level of detail for parity?
If the confirmation mechanism is indeed a "phrase" rather than simple yes/no, file 1's safety notes should be updated for consistency.
169-173: Consistent safety documentation fordev rmcommand.The note appropriately emphasizes data loss prevention with the phrase "hints at the risks involved", which is more cautious in tone than the
dev stopnote. This is suitable for a destructive operation.
There was a problem hiding this comment.
Actionable comments posted: 0
🧹 Nitpick comments (1)
content/200-orm/500-reference/200-prisma-cli-reference.mdx (1)
902-902: Minor wording: Simplify "outside of" to "outside".Line 902 currently reads: "This enables background instance management outside of the VS Code extension." Consider the slightly more concise: "This enables background instance management outside the VS Code extension." The meaning is identical, and the shorter form aligns with common technical writing conventions.
📜 Review details
Configuration used: Path: .coderabbit.yaml
Review profile: CHILL
Plan: Pro
📒 Files selected for processing (1)
content/200-orm/500-reference/200-prisma-cli-reference.mdx(3 hunks)
🧰 Additional context used
🪛 LanguageTool
content/200-orm/500-reference/200-prisma-cli-reference.mdx
[style] ~902-~902: This phrase is redundant. Consider using “outside”.
Context: ... enables background instance management outside of the VS Code extension. ### dev ls L...
(OUTSIDE_OF)
⏰ 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: Cloudflare Pages
🔇 Additional comments (2)
content/200-orm/500-reference/200-prisma-cli-reference.mdx (2)
882-912: Excellent documentation for newdev startanddev lscommands.The new sections are comprehensive and follow the existing documentation pattern well. The glob pattern explanations for
dev starthelp users understand how to target multiple instances, and the example you provided directly addresses the past review feedback. Thedev lssection is concise and clearly conveys its purpose.
934-938: Safety notes for destructive commands enhance user experience.Adding the interactive safety prompt notes to both
dev stopanddev rmis a valuable quality-of-life improvement. Users will now understand upfront that these operations include protections, which reduces the risk of accidental data loss or service interruption.Also applies to: 960-964
There was a problem hiding this comment.
Actionable comments posted: 0
🧹 Nitpick comments (2)
content/200-orm/500-reference/200-prisma-cli-reference.mdx (1)
916-916: Simplify redundant phrasing."Outside of the VS Code extension" can be shortened to "outside the VS Code extension" for clarity.
-This enables background instance management outside of the VS Code extension. +This enables background instance management outside the VS Code extension.content/250-postgres/300-database/550-local-development.mdx (1)
117-117: Simplify redundant phrasing (same as in CLI reference).Simplify "outside of the VS Code extension" to "outside the VS Code extension" for consistency and clarity.
-This command enables you to manage Prisma Postgres instances outside of the VS Code extension, allowing for background instance management in your development workflow. +This command enables you to manage Prisma Postgres instances outside the VS Code extension, allowing for background instance management in your development workflow.
📜 Review details
Configuration used: Path: .coderabbit.yaml
Review profile: CHILL
Plan: Pro
📒 Files selected for processing (2)
content/200-orm/500-reference/200-prisma-cli-reference.mdx(3 hunks)content/250-postgres/300-database/550-local-development.mdx(3 hunks)
🧰 Additional context used
🪛 LanguageTool
content/250-postgres/300-database/550-local-development.mdx
[style] ~117-~117: This phrase is redundant. Consider using “outside”.
Context: ...you to manage Prisma Postgres instances outside of the VS Code extension, allowing for bac...
(OUTSIDE_OF)
content/200-orm/500-reference/200-prisma-cli-reference.mdx
[style] ~916-~916: This phrase is redundant. Consider using “outside”.
Context: ... enables background instance management outside of the VS Code extension. ### dev ls L...
(OUTSIDE_OF)
⏰ 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: Cloudflare Pages
🔇 Additional comments (10)
content/200-orm/500-reference/200-prisma-cli-reference.mdx (5)
882-888: Good addition documenting named instances.The new section clearly explains how
--namecreates a named instance that persists across invocations. This is a valuable clarification for users managing multiple databases.
890-917: Clear documentation ofdev startwith practical examples.The section effectively explains glob-based pattern matching with concrete examples. The note that the command only works for pre-existing instances is important context that prevents user confusion.
918-926: Concise documentation fordev lscommand.The section is appropriately brief. Consider whether additional details about the output format (e.g., what status values or configuration details are shown) might be helpful, though this may belong in a separate reference section.
948-952: Safety note fordev stopis appropriate.The clarification that the command is interactive and includes safety prompts is valuable for user experience and prevents unintended operations. The note is clear and concise.
974-978: Safety note fordev rmwith good emphasis on data loss risk.The phrase "hints at the risks involved" effectively communicates the severity of the operation. This balances safety awareness with user guidance.
content/250-postgres/300-database/550-local-development.mdx (5)
86-89: Verify consistency of--namesyntax across documentation.The
--name="mydb1"syntax here uses quoted values. The CLI reference file (line 885) uses--name="mydbname"in a similar context. Verify that both quoting styles are functionally equivalent and that the documentation doesn't inadvertently suggest quotes are required when they may be optional.
91-117: Excellent documentation ofdev startcommand in context.This section effectively bridges the CLI reference with practical local development workflow guidance. The examples and notes work well together to explain both syntax and constraints.
119-127: Good coverage ofdev lscommand.The section is appropriately placed and explains the purpose clearly. The statement that it "shows their current status and configuration" aligns well with user expectations.
149-153: Safety note fordev stopadds helpful procedural detail.The note about typing a confirmation phrase is a useful concrete detail that helps users understand what to expect when running the command interactively.
175-179: Risk-aware safety note fordev rmis well-calibrated.The note appropriately emphasizes the destructive nature of the operation by mentioning data loss risk and the need for a confirmation phrase. This level of detail helps users make informed decisions.
Closes DR-6439 and DR-6247
Summary by CodeRabbit
Documentation
Chores
✏️ Tip: You can customize this high-level summary in your review settings.