docs: Prisma ORM 8 docs audit, personas, journeys, and proposed IA (for discussion) - #8243
Draft
wmadden-electric wants to merge 31 commits into
Draft
wmadden-electric wants to merge 31 commits into
wmadden-electric wants to merge 31 commits into
Conversation
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>
Contributor
|
Important Draft PR not reviewedDraft PRs are not automatically reviewed by default.
To automatically review draft PRs, update your CodeRabbit configuration: reviews:
auto_review:
drafts: trueComment |
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.
ankur-arch
reviewed
Sep 11, 2026
| ``` | ||
| Introduction | ||
| Prisma 8 | ||
| + Coming from Prisma 7 the mapping page: schema and types, CLI, client API, not-yet list |
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>
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>
…ocs/orm8-docs-audit-design
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>
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
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:
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:
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
/ormpage 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
README.md, thenpersonas.md: the four readers.journeys.md: ten jobs, each with what done looks like, what the docs must provide, and where the structure fails it.mental-model.md: the first-principles explanation (contract versus schema, emit, signature, plans, migrations and refs) that pages get written from.ia.md: the proposed sidebar trees and/ormpage, then the current state and the reasons.changes.md: every proposed change by kind, with the recommended order and the decisions that need an owner.naming.md, the three briefs handed to ORM-side agents, andaudit/, 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
/ormpage, and where the Prisma ORM 8 guides tree goes once the Prisma 7 guides have moved.Alternatives considered
🤖 Generated with Claude Code