Skip to content

docs: Prisma ORM 8 docs audit, personas, journeys, and proposed IA (for discussion) - #8243

Draft
wmadden-electric wants to merge 31 commits into
mainfrom
docs/orm8-docs-audit-design
Draft

wmadden-electric wants to merge 31 commits into
mainfrom
docs/orm8-docs-audit-design

Conversation

@wmadden-electric

@wmadden-electric wmadden-electric commented Sep 11, 2026

Copy link
Copy Markdown
Contributor

Most complaints about the Prisma ORM 8 docs come from two kinds of reader, and the site's entry points are built for a third:

The Newcomer   has an app already, wants typed queries; lands on pages that scaffold a new app for them
The Upgrader   has a Prisma ORM 7 app and a database with data; finds no page that says what moved or whether to move
The Builder    wants to ship on the platform with an agent's help; the root page, the agent prompts, and the tutorial are theirs

What this PR is

Draft, for discussion, not for merge as-is: the design documents behind the Prisma ORM 8 docs work, added under docs/orm-docs-audit/ so they can be read and commented in one place. They describe readers, the jobs those readers come to do, the mental model pages should be written from, the proposed information architecture, and the reasoning. They are design documents, not status: they describe the target and why, and do not track progress.

The decision they build up to

Serve the Newcomer and the Upgrader before the Builder at the ORM entry points, and organise the Getting Started > Prisma ORM subtree by the reader's starting state rather than by which tool runs:

  1. New app from scratch
  2. App already started, empty database
  3. Existing database with data
  4. Existing Prisma ORM 7 app

Each door is one page that carries the whole path. Two pages the Upgrader needs are added at the top level: "Coming from Prisma ORM 7" and "Release status". The /orm page shows the product (a contract, the query it enables, the typed result) instead of arguing for the design against Prisma ORM 7. Everything below the entry points (Data Modeling, Contract Authoring, Fundamentals, Migrations, Middleware, Extensions, Reference) stays where it is.

Reading order

  1. README.md, then personas.md: the four readers.
  2. journeys.md: ten jobs, each with what done looks like, what the docs must provide, and where the structure fails it.
  3. mental-model.md: the first-principles explanation (contract versus schema, emit, signature, plans, migrations and refs) that pages get written from.
  4. ia.md: the proposed sidebar trees and /orm page, then the current state and the reasons.
  5. changes.md: every proposed change by kind, with the recommended order and the decisions that need an owner.
  6. naming.md, the three briefs handed to ORM-side agents, and audit/, the page-by-page findings with a source citation for every claim.

What is already settled, and what is open

Settled: the readers and their order of priority; the naming rule (the product is Prisma ORM; a version number only when contrasting versions); the mental model as the source pages are written from; correcting the published pages before restructuring (done in #8236, #8237, #8238).

Open, and the reason this PR exists: the four-door structure of the ORM entry, the rewritten /orm page, and where the Prisma ORM 8 guides tree goes once the Prisma 7 guides have moved.

Alternatives considered

  • Restructure first, correct pages after. Rejected: readers were copying broken samples every day; corrections were mechanical and did not depend on the structure.
  • Organise the entry by database (PostgreSQL, MongoDB) at the top level. Rejected: the reader knows their starting state before they know which tool runs; the database split stays inside each door.
  • Keep the design in a shared document outside the repo. Rejected: the documents cite file paths and source lines, and reviewers are engineers who will read them next to the pages.

🤖 Generated with Claude Code

Personas, reader journeys, the mental model, the proposed information
architecture, the change list, the naming rule, the corrections slice
plan, two ORM briefs, and the page-by-page audit findings behind
#8236, #8237, and #8238. Shared for discussion; not site content.

Co-Authored-By: Claude Fable 5.1 <noreply@anthropic.com>
Signed-off-by: willbot <w.a.madden+machine@gmail.com>
Signed-off-by: Will Madden <madden@prisma.io>
@vercel

vercel Bot commented Sep 11, 2026

Copy link
Copy Markdown

The latest updates on your projects. Learn more about Vercel for GitHub.

Project Deployment Actions Updated
blog Ready Ready Preview Sep 16, 2026 9:22am UTC
docs Ready Ready Preview Sep 16, 2026 9:22am UTC
eclipse Ready Ready Preview Sep 16, 2026 9:22am UTC
site Ready Ready Preview Sep 16, 2026 9:22am UTC

Request Review

@coderabbitai

coderabbitai Bot commented Sep 11, 2026

Copy link
Copy Markdown
Contributor

Important

Draft PR not reviewed

Draft PRs are not automatically reviewed by default.

  • Trigger a manual review

To automatically review draft PRs, update your CodeRabbit configuration:

reviews:
  auto_review:
    drafts: true

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

Co-Authored-By: Claude Fable 5.1 <noreply@anthropic.com>
Signed-off-by: willbot <w.a.madden+machine@gmail.com>
Signed-off-by: Will Madden <madden@prisma.io>
…text

Status first, open work only in the recommended order, decisions with
owners, the shipped corrections collapsed to a summary, new pages grouped
by where they live, ORM changes grouped by owner, process residue removed.

Co-Authored-By: Claude Fable 5.1 <noreply@anthropic.com>
Signed-off-by: willbot <w.a.madden+machine@gmail.com>
Signed-off-by: Will Madden <madden@prisma.io>
… audit

The audit's citations use the worktree layout it was run in (wip/prisma-src,
wip/create-prisma-src, wip/web); README now says what each prefix maps to.
The db-ref brief named the monorepo prisma/prisma and said PRs go to
prisma/orm; it is one repository, renamed, so name it once. The "shipped"
wording for section B overstated PR 3: #8238 is still open. The model and
result type work is no longer "in open PRs": prisma/orm#30158 is in rc.9,
and #30231 / #30236 merged to main on 2026-09-10 and await a tagged release.
Comment thread docs/orm-docs-audit/ia.md
```
Introduction
Prisma 8
+ Coming from Prisma 7 the mapping page: schema and types, CLI, client API, not-yet list

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

love this!

personas, journeys, mental-model, ia, naming, and the briefs describe
readers, jobs, the target structure, and the reasoning; they carry no
done/in-progress markers, so they do not go stale as work lands.
journeys: per job, what the docs must provide and where the structure
fails, with the IA node that serves it. mental-model: naming, the plan
origin rule, whole-query raw SQL, the db ref rules and the adoption
design. Keeps the repo-name and tagged-release facts from the previous
commit.

Co-Authored-By: Claude Fable 5.1 <noreply@anthropic.com>
Signed-off-by: willbot <w.a.madden+machine@gmail.com>
Signed-off-by: Will Madden <madden@prisma.io>
Co-Authored-By: Claude Fable 5.1 <noreply@anthropic.com>
Signed-off-by: willbot <w.a.madden+machine@gmail.com>
Signed-off-by: Will Madden <madden@prisma.io>
…rm/reference

Co-Authored-By: Claude Fable 5.1 <noreply@anthropic.com>
Signed-off-by: willbot <w.a.madden+machine@gmail.com>
Signed-off-by: Will Madden <madden@prisma.io>
…migrations (C25)

Co-Authored-By: Claude Fable 5.1 <noreply@anthropic.com>
Signed-off-by: willbot <w.a.madden+machine@gmail.com>
Signed-off-by: Will Madden <madden@prisma.io>
Co-Authored-By: Claude Fable 5.1 <noreply@anthropic.com>
Signed-off-by: willbot <w.a.madden+machine@gmail.com>
Signed-off-by: Will Madden <madden@prisma.io>
Co-Authored-By: Claude Fable 5.1 <noreply@anthropic.com>
Signed-off-by: willbot <w.a.madden+machine@gmail.com>
Signed-off-by: Will Madden <madden@prisma.io>
wmadden-electric and others added 8 commits September 14, 2026 16:27
Co-Authored-By: Claude Fable 5.1 <noreply@anthropic.com>
Signed-off-by: willbot <w.a.madden+machine@gmail.com>
Signed-off-by: Will Madden <madden@prisma.io>
Co-Authored-By: Claude Fable 5.1 <noreply@anthropic.com>
Signed-off-by: willbot <w.a.madden+machine@gmail.com>
Signed-off-by: Will Madden <madden@prisma.io>
Co-Authored-By: Claude Opus 5 <noreply@anthropic.com>
Signed-off-by: willbot <w.a.madden+machine@gmail.com>
Signed-off-by: Will Madden <madden@prisma.io>
…sions

Co-Authored-By: Claude Fable 5.1 <noreply@anthropic.com>
Signed-off-by: willbot <w.a.madden+machine@gmail.com>
Signed-off-by: Will Madden <madden@prisma.io>
Co-Authored-By: Claude Fable 5.1 <noreply@anthropic.com>
Signed-off-by: willbot <w.a.madden+machine@gmail.com>
Signed-off-by: Will Madden <madden@prisma.io>
Co-Authored-By: Claude Fable 5.1 <noreply@anthropic.com>
Signed-off-by: willbot <w.a.madden+machine@gmail.com>
Signed-off-by: Will Madden <madden@prisma.io>
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.

3 participants