feat: DC-5662 Update glossary + dataguide index #7185

carlagn · 2025-10-14T10:11:55Z

Fixes #DC-5662

Summary by CodeRabbit

Documentation
- Added a comprehensive Database Glossary as a living reference with an introduction and extensive terminology entries covering normalization, caching, architectures, transaction models, and related concepts.
- Added a Data Guide landing page with front matter, descriptive top block, and organized subsections for improved discoverability and navigation.
Chores
- Expanded the spell-check dictionary to include new database and architecture terms used in the glossary.

coderabbitai · 2025-10-14T10:12:09Z

Walkthrough

Adds two new documentation pages under the Prisma Data Guide (an index page and a comprehensive database glossary) and updates the spellcheck dictionary (cSpell.json) with multiple database-related terms. No runtime code changes.

Changes

Cohort / File(s)	Summary of changes
Data Guide: New pages `content/200-orm/800-more/600-help-and-troubleshooting/050-dataguide/index.mdx`, `content/200-orm/800-more/600-help-and-troubleshooting/050-dataguide/050-database-glossary.mdx`	Added an index MDX with front matter, TopBlock, and Subsections scaffold; added a comprehensive database glossary MDX containing an Introduction and extensive Terminology entries (normalization forms, caching strategies, architectures, concurrency terms, etc.).
Spellcheck additions `cSpell.json`	Appended multiple database-related words to the `words` list (e.g., `BCNF`, `multivalued`, `Boyce`, `Codd`, `HTAP`, `Multiversion`, `MVCC`, `OLAP`, `OLTP`, `Nonrepeatable`, `RDBMS`, `Superkey`, `Dataguide`, etc.).

Estimated code review effort

🎯 3 (Moderate) | ⏱️ ~20 minutes

Pre-merge checks

✅ Passed checks (3 passed)

Check name	Status	Explanation
Description Check	✅ Passed	Check skipped - CodeRabbit’s high-level summary is enabled.
Title Check	✅ Passed	The title clearly and concisely summarizes the main change by indicating that the glossary and Data Guide index were updated, aligns with the PR objectives, and avoids unnecessary detail or vague phrasing.
Docstring Coverage	✅ Passed	No functions found in the changes. Docstring coverage check skipped.

📜 Recent review details

Configuration used: Path: .coderabbit.yaml

Review profile: CHILL

Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between a769f50 and 51d05fc.

📒 Files selected for processing (1)

content/200-orm/800-more/600-help-and-troubleshooting/050-dataguide/050-database-glossary.mdx (1 hunks)

✅ Files skipped from review due to trivial changes (1)

content/200-orm/800-more/600-help-and-troubleshooting/050-dataguide/050-database-glossary.mdx

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

coderabbitai

Actionable comments posted: 1

📜 Review details

Configuration used: Path: .coderabbit.yaml

Review profile: CHILL

Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between 2b7c440 and 5875f9d.

📒 Files selected for processing (2)

content/200-orm/800-more/600-help-and-troubleshooting/050-dataguide/050-database-glossary.mdx (1 hunks)
content/200-orm/800-more/600-help-and-troubleshooting/050-dataguide/index.mdx (1 hunks)

content/200-orm/800-more/600-help-and-troubleshooting/050-dataguide/050-database-glossary.mdx

cloudflare-workers-and-pages · 2025-10-14T10:14:16Z

Deploying docs with Cloudflare Pages

Latest commit:	`51d05fc`
Status:	✅ Deploy successful!
Preview URL:	https://a6d762ad.docs-51g.pages.dev
Branch Preview URL:	https://feat-dc-5662-dataguide-migra.docs-51g.pages.dev

View logs

github-actions · 2025-10-14T10:14:58Z

Dangerous URL check

No absolute URLs to prisma.io/docs found.
No local URLs found.

github-actions · 2025-10-14T10:15:05Z

Redirect check

This PR probably requires the following redirects to be added to static/_redirects:

This PR does not change any pages in a way that would require a redirect.

github-actions · 2025-10-14T10:15:07Z

original	preview
content/200-orm/800-more/600-help-and-troubleshooting/050-dataguide/050-database-glossary.mdx	content/200-orm/800-more/600-help-and-troubleshooting/050-dataguide/050-database-glossary.mdx
content/200-orm/800-more/600-help-and-troubleshooting/050-dataguide/index.mdx	content/200-orm/800-more/600-help-and-troubleshooting/050-dataguide/index.mdx

coderabbitai

Actionable comments posted: 21

🧹 Nitpick comments (1)

content/200-orm/800-more/600-help-and-troubleshooting/050-dataguide/index.mdx (1)
2-5: Use consistent “Prisma Data Guide” naming.

Current uses “Dataguide”; elsewhere we use “Data Guide”. Align title, metaTitle, and section header.
-title: 'Dataguide'
-metaTitle: 'Prisma Dataguide articles'
+title: 'Prisma Data Guide'
+metaTitle: 'Prisma Data Guide articles'
@@
-## Prisma Dataguide articles
+## Prisma Data Guide articles
Also applies to: 14-16

📜 Review details

Configuration used: Path: .coderabbit.yaml

Review profile: CHILL

Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between ded4888 and 94172c4.

📒 Files selected for processing (2)

content/200-orm/800-more/600-help-and-troubleshooting/050-dataguide/050-database-glossary.mdx (1 hunks)
content/200-orm/800-more/600-help-and-troubleshooting/050-dataguide/index.mdx (1 hunks)

⏰ 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). (3)

GitHub Check: Check internal links
GitHub Check: runner / linkspector
GitHub Check: Cloudflare Pages

content/200-orm/800-more/600-help-and-troubleshooting/050-dataguide/050-database-glossary.mdx

coderabbitai

Actionable comments posted: 2

📜 Review details

Configuration used: Path: .coderabbit.yaml

Review profile: CHILL

Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between ded4888 and 055bff9.

📒 Files selected for processing (3)

cSpell.json (1 hunks)
content/200-orm/800-more/600-help-and-troubleshooting/050-dataguide/050-database-glossary.mdx (1 hunks)
content/200-orm/800-more/600-help-and-troubleshooting/050-dataguide/index.mdx (1 hunks)

🧰 Additional context used

🪛 GitHub Actions: Documentation Checks

content/200-orm/800-more/600-help-and-troubleshooting/050-dataguide/index.mdx

[error] 2-2: Unknown word (Dataguide) detected by cspell. Command failed: cspell --config ./cSpell.json "content/**/*.mdx" --no-progress (exit code 1).

[error] 3-3: Unknown word (Dataguide) detected by cspell. Command failed: cspell --config ./cSpell.json "content/**/*.mdx" --no-progress (exit code 1).

[error] 14-14: Unknown word (Dataguide) detected by cspell. Command failed: cspell --config ./cSpell.json "content/**/*.mdx" --no-progress (exit code 1).

⏰ 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). (3)

GitHub Check: runner / linkspector
GitHub Check: Check internal links
GitHub Check: Cloudflare Pages

content/200-orm/800-more/600-help-and-troubleshooting/050-dataguide/050-database-glossary.mdx

cSpell.json

coderabbitai

Actionable comments posted: 0

🧹 Nitpick comments (1)

cSpell.json (1)

101-116: Additions LGTM; “Dataguide” now included (unblocks cSpell).

Entries look correct. Please verify both case variants are needed (e.g., Nonrepeatable/nonrepeatable, Superkey/superkey). If only one is used, drop the other to keep the list lean. Optional: dedupe existing duplicates elsewhere in this list in a follow-up.

📜 Review details

Configuration used: Path: .coderabbit.yaml

Review profile: CHILL

Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between 055bff9 and 7400052.

📒 Files selected for processing (1)

cSpell.json (1 hunks)

⏰ 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: runner / linkspector

coderabbitai

Actionable comments posted: 2

♻️ Duplicate comments (4)

content/200-orm/800-more/600-help-and-troubleshooting/050-dataguide/050-database-glossary.mdx (4)
561-567: Fix verb agreement in the encoding definition.

Line 563 currently says “can represents”; it should be “can represent”. While you’re here, capitalize “Unicode” and use the “UTF encodings” phrasing.
-Encoding is a system that translates between a character system that can represents the components used in written language and a digital representation that the computer can store and operate on. Different encoding systems have been developed with a wide variety of character ranges. Some are targeted at specific languages or language families (like ASCII) while others attempt to provide representation for many different languages (like the unicode UTF varieties).
+Encoding is a system that translates between a character system that can represent the components used in written language and a digital representation that the computer can store and operate on. Different encoding systems have been developed with a wide variety of character ranges. Some are targeted at specific languages or language families (like ASCII) while others attempt to provide representation for many different languages (like the Unicode UTF encodings).
595-603: Grammar fix: “Eventually consistent systems…”.

Line 600 still says “Eventual consistent systems”; switch to the adverbial form.
-Eventual consistent systems make the choice to favor availability
+Eventually consistent systems make the choice to favor availability
1506-1511: Subject–verb agreement for “Upsert operations”.

Line 1508 says “Upsert operations consists…”; use the plural verb.
-  inserts a new entry when no current entry is found. Upsert operations consists
+  inserts a new entry when no current entry is found. Upsert operations consist
1569-1573: Hyphenate “write-ahead logging/log”.

Line 1571 should hyphenate both occurrences for consistency.
-  with write ahead logging, the system records its intentions to a durable write ahead log
+  with write-ahead logging, the system records its intentions to a durable write-ahead log

📜 Review details

Configuration used: Path: .coderabbit.yaml

Review profile: CHILL

Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between a618fe1 and a769f50.

📒 Files selected for processing (1)

content/200-orm/800-more/600-help-and-troubleshooting/050-dataguide/050-database-glossary.mdx (1 hunks)

⏰ 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

content/200-orm/800-more/600-help-and-troubleshooting/050-dataguide/050-database-glossary.mdx

coderabbitai bot requested changes Oct 14, 2025

View reviewed changes

content/200-orm/800-more/600-help-and-troubleshooting/050-dataguide/050-database-glossary.mdx Outdated Show resolved Hide resolved

carlagn requested review from AmanVarshney01, Techboidesign, aidankmcalister, ankur-arch, mhartington, mhessdev, nikolasburk and nurul3101 October 14, 2025 10:15

coderabbitai bot previously approved these changes Oct 14, 2025

View reviewed changes

carlagn added 2 commits October 14, 2025 11:34

Update glossary + dataguide index

0578307

fix typo

94172c4

carlagn force-pushed the feat/DC-5662-dataguide-migration-glossary branch from ded4888 to 94172c4 Compare October 14, 2025 10:34

Add to cSpell

055bff9

carlagn dismissed coderabbitai[bot]’s stale review via 055bff9 October 14, 2025 10:40

coderabbitai bot requested changes Oct 14, 2025

View reviewed changes

content/200-orm/800-more/600-help-and-troubleshooting/050-dataguide/050-database-glossary.mdx Show resolved Hide resolved

cSpell.json Outdated Show resolved Hide resolved

Add dataguide to allowed words

7400052

coderabbitai bot reviewed Oct 14, 2025

View reviewed changes

carlagn added 2 commits October 14, 2025 12:07

update suggestion link

a618fe1

Fix grammar/typos

a769f50

coderabbitai bot requested changes Oct 14, 2025

View reviewed changes

content/200-orm/800-more/600-help-and-troubleshooting/050-dataguide/050-database-glossary.mdx Show resolved Hide resolved

content/200-orm/800-more/600-help-and-troubleshooting/050-dataguide/050-database-glossary.mdx Outdated Show resolved Hide resolved

Fix grammar

51d05fc

coderabbitai bot approved these changes Oct 14, 2025

View reviewed changes

carlagn mentioned this pull request Oct 14, 2025

Feat: DC-5300 migrate "connection-uris" #7183

Merged

mhartington approved these changes Oct 14, 2025

View reviewed changes

carlagn merged commit b96ac5c into main Oct 15, 2025
8 of 9 checks passed

carlagn deleted the feat/DC-5662-dataguide-migration-glossary branch October 15, 2025 07:58

This was referenced Oct 15, 2025

feat: DC-5297 Migrate page #2 #7180

Merged

feat: DC-5298 migrate "date-types" #7181

Merged

coderabbitai bot mentioned this pull request Nov 11, 2025

feat: restructure getting started side nav #7244

Closed

feat: DC-5662 Update glossary + dataguide index #7185

feat: DC-5662 Update glossary + dataguide index #7185

Uh oh!

Conversation

carlagn commented Oct 14, 2025 • edited by coderabbitai bot Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Summary by CodeRabbit

Uh oh!

coderabbitai bot commented Oct 14, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Walkthrough

Changes

Estimated code review effort

Pre-merge checks

Uh oh!

coderabbitai bot left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

cloudflare-workers-and-pages bot commented Oct 14, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Deploying docs with Cloudflare Pages

Uh oh!

github-actions bot commented Oct 14, 2025

Dangerous URL check

Uh oh!

github-actions bot commented Oct 14, 2025

Redirect check

Uh oh!

github-actions bot commented Oct 14, 2025

Uh oh!

coderabbitai bot left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

coderabbitai bot left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

coderabbitai bot left a comment

Choose a reason for hiding this comment

Uh oh!

coderabbitai bot left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

3 participants

carlagn commented Oct 14, 2025 •

edited by coderabbitai bot

Loading

coderabbitai bot commented Oct 14, 2025 •

edited

Loading

cloudflare-workers-and-pages bot commented Oct 14, 2025 •

edited

Loading