Skip to content

fix(docs): correct typos and grammar in ORM and Studio docs#7901

Open
monqyClouds wants to merge 1 commit into
prisma:mainfrom
monqyClouds:docs/fix-typos-and-grammar
Open

fix(docs): correct typos and grammar in ORM and Studio docs#7901
monqyClouds wants to merge 1 commit into
prisma:mainfrom
monqyClouds:docs/fix-typos-and-grammar

Conversation

@monqyClouds
Copy link
Copy Markdown

@monqyClouds monqyClouds commented May 15, 2026

What changed and why

Seven small text fixes in apps/docs/content/:

Spelling / wrong word / duplicate word

  • docs/studio/integrations/embedding.mdx — "Create an quick admin dashboard" → "a quick…" (wrong article)
  • docs/orm/prisma-migrate/workflows/baselining.mdx — image alt text "surrounded by a a box" → "a box" (duplicate)
  • docs/orm/more/comparisons/prisma-and-typeorm.mdx — heading "Loosing type-safety" → "Losing" (loose ≠ lose)

Grammar — "allows to ..." (not valid English, needs an object)

  • docs/orm/more/comparisons/prisma-and-sequelize.mdx (line 19) — "Prisma Migrate then allows to generate" → "allows you to generate" (and matched the verb agreement in the following clause: "execute them")
  • docs/orm/more/comparisons/prisma-and-typeorm.mdx (line 19) — same fix
  • docs/orm/more/comparisons/prisma-and-typeorm.mdx (line 300) — "TypeORM allows to eagerly load" → "allows you to eagerly load"
  • docs/orm/more/comparisons/prisma-and-typeorm.mdx (line 430) — "TypeORM allows to pass" → "allows you to pass"

The same wording exists in the frozen docs/orm/v6/... snapshot — I left those alone on the assumption that versioned docs are intentionally frozen. Happy to mirror the fixes there if you'd prefer.

How it was tested

Edits are text-only and don't change any code samples, links, anchors, or alt-text used as a key elsewhere. Reviewed with git diff.

Follow-ups / known limitations

None.

Summary by CodeRabbit

  • Documentation
    • Improved grammar and clarity across ORM comparison guides
    • Enhanced wording consistency in baselining documentation
    • Updated embedded diagram in baselining section
    • Corrected spelling in studio integration documentation

Review Change Stack

- studio/embedding: "an quick" -> "a quick"
- prisma-migrate/baselining: remove duplicate "a a" in image alt text
- orm/comparisons/prisma-and-typeorm: "Loosing" -> "Losing"
- orm/comparisons: rephrase ungrammatical "allows to ..." as
  "allows you to ..." (sequelize x1, typeorm x3)
@vercel
Copy link
Copy Markdown

vercel Bot commented May 15, 2026

Someone is attempting to deploy a commit to the Prisma Team on Vercel.

A member of the Team first needs to authorize it.

@coderabbitai
Copy link
Copy Markdown
Contributor

coderabbitai Bot commented May 15, 2026

No actionable comments were generated in the recent review. 🎉

ℹ️ Recent review info
⚙️ Run configuration

Configuration used: Path: .coderabbit.yaml

Review profile: CHILL

Plan: Pro

Run ID: 6cb54403-5655-4a79-ad1c-011044566f43

📥 Commits

Reviewing files that changed from the base of the PR and between 32e7910 and f23a4d5.

📒 Files selected for processing (4)
  • apps/docs/content/docs/orm/more/comparisons/prisma-and-sequelize.mdx
  • apps/docs/content/docs/orm/more/comparisons/prisma-and-typeorm.mdx
  • apps/docs/content/docs/orm/prisma-migrate/workflows/baselining.mdx
  • apps/docs/content/docs/studio/integrations/embedding.mdx

Walkthrough

This pull request corrects grammar, spelling, and phrasing across four documentation files in the Prisma documentation: standardizing "allows you to" language in ORM comparison pages, fixing a spelling error in a TypeORM section heading, updating a diagram in the Prisma Migrate baselining guide, and correcting a grammar issue in the Studio embedding guide.

Changes

Documentation corrections across ORM comparisons, Prisma Migrate, and Studio guides

Layer / File(s) Summary
ORM comparison grammar and wording fixes
apps/docs/content/docs/orm/more/comparisons/prisma-and-sequelize.mdx, apps/docs/content/docs/orm/more/comparisons/prisma-and-typeorm.mdx
Grammar adjustments in Sequelize and TypeORM comparison pages: standardized "allows you to" phrasing for Prisma Migrate descriptions, reworded TypeORM eager-load and filtering descriptions, and corrected "Loosing type-safety" heading to "Losing type-safety".
Prisma Migrate baselining diagram update
apps/docs/content/docs/orm/prisma-migrate/workflows/baselining.mdx
Image replacement in the "Why you need to baseline" section of the baselining workflow guide.
Studio embedding documentation grammar fix
apps/docs/content/docs/studio/integrations/embedding.mdx
Corrected grammar in a "Use cases" bullet point from "an quick" to "a quick".

Estimated code review effort

🎯 1 (Trivial) | ⏱️ ~3 minutes

🚥 Pre-merge checks | ✅ 5
✅ Passed checks (5 passed)
Check name Status Explanation
Description Check ✅ Passed Check skipped - CodeRabbit’s high-level summary is enabled.
Title check ✅ Passed The PR title accurately summarizes the main objective: correcting typos and grammar issues across ORM and Studio documentation files.
Docstring Coverage ✅ Passed No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.
Linked Issues check ✅ Passed Check skipped because no linked issues were found for this pull request.
Out of Scope Changes check ✅ Passed Check skipped because no linked issues were found for this pull request.

✏️ Tip: You can configure your own custom pre-merge checks in the settings.

Warning

There were issues while running some tools. Please review the errors and either fix the tool's configuration or disable the tool if it's a critical failure.

🔧 ESLint

If the error stems from missing dependencies, add them to the package.json file. For unrecoverable errors (e.g., due to private dependencies), disable the tool in the CodeRabbit configuration.

ESLint skipped: no ESLint configuration detected in root package.json. To enable, add eslint to devDependencies.

Tip

💬 Introducing Slack Agent: The best way for teams to turn conversations into code.

Slack Agent is built on CodeRabbit's deep understanding of your code, so your team can collaborate across the entire SDLC without losing context.

  • Generate code and open pull requests
  • Plan features and break down work
  • Investigate incidents and troubleshoot customer tickets together
  • Automate recurring tasks and respond to alerts with triggers
  • Summarize progress and report instantly

Built for teams:

  • Shared memory across your entire org—no repeating context
  • Per-thread sandboxes to safely plan and execute work
  • Governance built-in—scoped access, auditability, and budget controls

One agent for your entire SDLC. Right inside Slack.

👉 Get started


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.

❤️ Share

Comment @coderabbitai help to get the list of available commands and usage tips.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant