Skip to content
Draft
Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
31 commits
Select commit Hold shift + click to select a range
3cdd07d
docs: add the Prisma ORM 8 docs audit and restructure proposal
wmadden-electric Sep 11, 2026
cdd48e5
docs: add the prisma-8 skill staleness brief to the audit
wmadden-electric Sep 11, 2026
f25edb9
docs: rewrite the audit change list for readers without the audit con…
wmadden-electric Sep 11, 2026
18b607d
docs: correct repo names, PR status, and citation key in the ORM docs…
Reviewer Sep 11, 2026
7e815e7
docs: keep the audit design documents free of progress state
wmadden-electric Sep 11, 2026
328bcf1
docs: state the real reason for the naming rule, brand separation
wmadden-electric Sep 11, 2026
476adee
docs: reconcile the ORM docs audit with #8242 and make the naming cou…
Sep 11, 2026
9c3405d
Merge remote-tracking branch 'origin/main' into docs/orm8-docs-audit-…
Sep 11, 2026
dc1ca33
docs: correct the Temporal-by-Node.js-version fact
wmadden-electric Sep 11, 2026
5ed9a9a
docs: restore the change list's A7 and C6 updates; keep the Temporal …
wmadden-electric Sep 11, 2026
b46e898
docs: Temporal ships in Node.js 26; the polyfill is for 25 and earlier
wmadden-electric Sep 11, 2026
f4266e7
docs: reconcile the audit's counts with the tree and the same PR's Te…
Sep 11, 2026
5dce14b
docs: mark the audit's overruled streaming claim and fix the upgrade-…
Sep 11, 2026
df980a3
docs: the release status facts are decided; drop the C4 decision row
wmadden-electric Sep 11, 2026
63e9420
docs: add the plain-language rule and reader-review process
wmadden-electric Sep 11, 2026
babb53f
docs: add the plain-language pass over the reference pages to the cha…
wmadden-electric Sep 11, 2026
e1506b3
docs: local database and runnable-example journeys, IA node, and chan…
wmadden-electric Sep 12, 2026
f0996aa
docs: keep the branch's newer ia and journeys text; add only J11, J12…
wmadden-electric Sep 12, 2026
c02aa15
docs: handover brief for the next agent
wmadden-electric Sep 12, 2026
35d1168
docs: handover brief, orm-client page finished, next is the rest of o…
wmadden-electric Sep 12, 2026
cfbf406
docs: brief for documenting intermediate contracts in data transform …
wmadden-electric Sep 13, 2026
82ddf61
docs: handover after the orm/reference section (#8267)
wmadden-electric Sep 13, 2026
056dcc6
docs: handover after the contract-authoring section (#8271)
wmadden-electric Sep 14, 2026
429ca8f
Merge remote-tracking branch 'origin/main' into docs/orm8-docs-audit-…
wmadden-electric Sep 14, 2026
07800c5
docs: absolute paths in the handover
wmadden-electric Sep 14, 2026
00f0382
Merge remote-tracking branch 'bot/docs/orm8-docs-audit-design' into d…
wmadden-electric Sep 15, 2026
4613d6f
docs: handover after the data-modeling section
wmadden-electric Sep 15, 2026
dc7b37f
docs: handover after the migrations section
wmadden-electric Sep 15, 2026
a5eeb8f
docs(audit): record the migrations cutting round and terminology deci…
wmadden-electric Sep 16, 2026
414eaa8
docs(audit): record the explanation round and the explain-not-state rule
wmadden-electric Sep 16, 2026
93bba1b
docs(audit): delete HANDOVER.md
wmadden-electric Sep 16, 2026
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
19 changes: 19 additions & 0 deletions docs/orm-docs-audit/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,19 @@
# Prisma ORM 8 docs audit

Working documents behind the Prisma ORM 8 docs corrections (prisma/web #8236, #8237, #8238) and the proposed restructure. Written September 2026 against `@prisma/orm-postgres@8.0.0-rc.9`; source paths refer to the prisma/orm monorepo at that tag (`packages/`, `docs/releases/`, `examples/`, `skills/prisma-8/`) and to prisma/create-prisma. Site paths are relative to `apps/docs/content/docs/`.

Citations in `audit/` use the worktree layout the audit was run in: `wip/prisma-src/` is prisma/orm (formerly prisma/prisma; the old name still redirects) at `v8.0.0-rc.9`, `wip/create-prisma-src/` is prisma/create-prisma, and `wip/docs-audit/` is this directory. Strip the prefix to get the path in the named repository.

Read in this order:

1. `personas.md` — who reads the ORM docs: the Newcomer, the Upgrader, the Builder, the Agent.
2. `journeys.md` — ten jobs those readers come to do, with an entry point, a done criterion, the path through today's pages, and a verdict.
3. `mental-model.md` — the standalone explanation of Prisma ORM 8 (contract, emit, signature, plans, migrations and refs) that pages get written from.
4. `ia.md` — the proposed sidebar trees and `/orm` page structure, then the current state and the reasons.
5. `changes.md` — every proposed change by kind: restructure (A), corrections to existing pages (B; #8236 and #8237 are merged, #8238 is open as of 2026-09-11), new pages (C), ORM changes (D). Leads with the suggested order.
6. `naming.md` — the "Prisma ORM" naming rule. `plain-language.md` — the rule every page must follow so it reads as written by a person for an ordinary user, with the banned-word list and the reader-review step.
7. `slice-corrections.md` — how the section B corrections were sliced, and the decisions taken.
8. `brief-db-ref-on-adoption.md`, `brief-skills-opt-out.md`, `brief-skill-staleness.md` — three ORM-side changes handed to other agents; `brief-intermediate-contracts.md` — a docs page to write (C25) (adoption sets the `db` ref; a skills opt-out in create-prisma; bringing the `prisma-8` agent skill up to rc.9).
9. `audit/` — the page-by-page audit findings that section B and much of C and D were built from. `INSTRUCTIONS.md` and `AREAS.md` describe how the audit was run; the seven area files hold the findings with source citations. The audit is a snapshot of the site on 2026-09-10; the guides pages it flags as Prisma 7 content were rewritten for Prisma ORM 8 in #8242 on 2026-09-11.

Prose is a draft throughout; the structure and the cited facts are what has been verified.
24 changes: 24 additions & 0 deletions docs/orm-docs-audit/audit/AREAS.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,24 @@
# Audit areas and page lists

Site paths are relative to `apps/docs/content/docs/`.

## orm-client
orm/index.mdx, orm/core-concepts.mdx, orm/fundamentals/{reading-data,writing-data,relations-and-joins,advanced-queries,transactions}.mdx, orm/reference/{index,orm-client,transactions-and-runtime,error-reference}.mdx

## builders
orm/reference/{sql-query-builder,pipeline-builder,raw-queries}.mdx, orm/extensions/using-extensions.mdx, orm/middleware/{how-middleware-works,authoring-custom-middleware,built-in-lints,built-in-budgets,built-in-cache}.mdx

## contract
orm/contract-authoring/{the-data-contract,the-contract-artifact,psl-syntax,typescript-schema-builder,capabilities}.mdx, orm/data-modeling/{index,relational-databases,mongodb}.mdx, cli/{contract-emit,contract-infer}.mdx

## migrations-cli
orm/migrations/*.mdx (6), cli/{index,global-flags,configuration,error-reference,init,orm-init,skills,dev,git}.mdx, cli/db-{init,update,migrate,sign,verify,schema}.mdx, cli/migration-{new,plan,ref,show,status}.mdx. Platform commands (auth, branch, bucket, deploy, feedback, postgres, project, service, telemetry) out of scope.

## start-guides
(index)/{index,getting-started}.mdx, (index)/prisma-orm/{index,create-prisma}.mdx, (index)/prisma-orm/quickstart/{postgresql,mongodb}.mdx, (index)/prisma-orm/add-to-existing-project/{postgresql,mongodb}.mdx, (index)/prisma-postgres/quickstart/prisma-orm.mdx, guides/index.mdx, guides/upgrade-prisma-orm/{postgresql,mongodb}.mdx, guides/switch-to-prisma-orm/*.mdx (3), guides/database/*.mdx (3)

## gaps
Part 1: guides/frameworks/*.mdx (10), guides/deployment/*.mdx (6), guides/runtimes/*.mdx (2), guides/integrations/{github-actions,vercel-deployment,ai-sdk}.mdx. Part 2: reverse audit of skills/prisma-8/ and docs/glossary.md and the public export maps against the whole ORM 8 site.

## extras
(index)/full-stack-tutorial.mdx, ai/tools/skills.mdx, cli/telemetry.mdx, plus the targeted gap questions from the first session's gaps brief (RLS, expression indexes, Postgres extensions, JSON filtering, Decimal, SQLite, Vite plugin, @@control, soft delete, read replicas, await using, streaming, native provider, docs/reference/*, extension packages).
74 changes: 74 additions & 0 deletions docs/orm-docs-audit/audit/INSTRUCTIONS.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,74 @@
# Audit instructions (shared by every area agent)

You are auditing the Prisma ORM docs site against the Prisma 8 monorepo at rc.9. The goal is a list of things on the site that are wrong, out of date, or missing, with evidence.

## Where things are

Work only inside the docs worktree. Do not edit any file except your own output file. Put scratch files in `wip/docs-audit/audit/scratch-<area>/`.

- Docs site source: `apps/docs/content/docs/` (this worktree is the `prisma/web` repo). Cite site paths relative to that directory, for example `orm/fundamentals/reading-data.mdx:42`. Prisma ORM 8 pages are under `orm/` (not `orm/v6`, `orm/v7`), `(index)/prisma-orm/`, `(index)/getting-started.mdx`, `cli/` (not `cli/v7`), and the ORM parts of `guides/`.
- The monorepo (the truth) is checked out at rc.9 under `wip/prisma-src/`. Inside it: `packages/` for source, `docs/releases/v8.0.0-rc.*.md` and `docs/releases/v0.1[5-7].0.md` for what changed and when, `docs/glossary.md` for terms, `skills/prisma-8/` for the shipped agent skill (`SKILL.md` plus `references/*.md`). The skill is well maintained and a good second source, but it uses `@internal/*` import paths that users must read as `@prisma/orm-postgres/*`; do not report that, it is known.
- The public package: `packages/9-public/@prisma/orm-postgres/package.json` lists the real export paths users import.
- create-prisma source (what the scaffold generates): `wip/create-prisma-src/`.
- Worked examples that compile against rc.9: `wip/prisma-src/examples/`.

## How to work

- Read every page in your area in full. Do not skim headings.
- For every API name, method, flag, command, config key, file path, import path, type name, and error code on a page, check it exists in the source with that name and shape. Grep `packages/` and `skills/prisma-8/references/`. Check `docs/releases/` for renames.
- For every code sample, ask: would this typecheck and run on rc.9? You do not need to run it, but you must be able to point at the source that says yes or no.
- Verify before reporting. A finding must cite a file in the monorepo or a release note. If you cannot find evidence either way, report it under "Unverified" with what you looked for.
- Also look the other way: what does the source or skill support in your area that the site never mentions? Report those under "Missing".
- The product is called "Prisma ORM"; do not report pages that say "Prisma 8", that is a known site-wide naming issue.
- Do not report the items already known (list below). Do not report prose style, tone, or the "written for AI" complaint. Do not report `@internal/*` in the skill.

## Already known, do not re-report

- `.take()`/`.skip()` should be `.limit()`/`.offset()` (renamed rc.7).
- `createCount`/`updateCount`/`deleteCount` should be `createAndCount` etc. (renamed 0.17).
- The existing-project PostgreSQL page uses `db.orm.User` and `db.sql.user` instead of `db.orm.public.User` / `db.sql.public.user`.
- `@db.*` attributes were removed in 0.17; `psl-syntax.mdx` still shows `String @db.Uuid`.
- `orm/index.mdx` says SQLite is planned; it ships as `@prisma/orm-sqlite`.
- The upgrade guide is pinned to rc.6 / rc.4.
- `db sign` does not set the `db` ref, so `migration plan` after adoption plans from empty.
- No page covers: a Prisma 7 to 8 API mapping, model/result types (`Models`, `Shape<>`, in open PRs), `createMany`/`skipDuplicates`, `firstOrThrow`, atomic increment, case-insensitive filters, editor setup, RLS outside Supabase, functional indexes, pg_trgm, money/Decimal, the skills opt-out on getting-started pages, the npm `latest` tag / release status.
- `DATABASE_URL` from `.env` vs the environment is inconsistent across getting-started pages; `db.connect()` vs `db.runtime()` is used interchangeably; `db.ts` is imported but never shown on getting-started pages; Node version claims differ.

## Output

Write your findings to `wip/docs-audit/audit/<area>.md` (the area name is given in your prompt). Use exactly this structure. Markdown, no hard-wrapped lines, plain English, no invented jargon.

```
# Audit: <area>

Pages read: <list>

## Breaks copy-paste
Things a user copies that fail: wrong name, removed API, wrong flag, wrong path, wrong import.

- `<page path>:<line>` — <what the page says> — <what is true> — evidence: `<monorepo path or release note>`

## Misleading
True-ish statements that lead the user wrong: stale defaults, changed behaviour, wrong claims about what is supported.

- (same format)

## Missing
Things the source or skill supports in this area that the site never mentions, or that a user in this area would need and cannot find.

- <feature> — evidence it exists: `<path>` — where on the site it belongs

## Unverified
Things that looked wrong but you could not confirm either way.

- `<page path>:<line>` — <suspicion> — <what you checked>

## Skill vs site
Places where the shipped skill (`skills/prisma-8/references/`) and the site disagree, beyond the items above. Say which one matches the source.

- (same format)
```

Keep each bullet to the facts. Line numbers are from the site file. When one defect repeats across many lines, give the count and the first line, not every line.

When finished, return a two-paragraph summary: how many findings in each section, and the three most serious.
Loading
Loading