Skip to content

docs: consumer docs (README + guides) and one installable prisma-composer skill#90

Open
wmadden-electric wants to merge 3 commits into
mainfrom
claude/composer-team-skills-f86e54
Open

docs: consumer docs (README + guides) and one installable prisma-composer skill#90
wmadden-electric wants to merge 3 commits into
mainfrom
claude/composer-team-skills-f86e54

Conversation

@wmadden-electric

@wmadden-electric wmadden-electric commented Jul 15, 2026

Copy link
Copy Markdown
Contributor

Two audiences, one surface: human guides (canonical) and an installable agent skill (the condensed mirror), plus a consumer-oriented root README linking both.

Human docs

  • README.md reoriented toward people building apps on Composer: what a service and root module look like, the real examples/store topology in place of the aspirational diagram, a guides table, an examples table, the agent-skill install. Design docs demoted to a "Design & internals" section. Shipped surface only — unshipped design (stream connections, shared-Postgres contract slices, topology artifact queries) is no longer presented as current.
  • docs/guides/ — four guides, canonical for humans:
    • getting-started.md — empty directory to a deployed two-service app
    • building-an-app.md — contracts, databases (postgres / pnPostgres + migrations), authoring reusable Modules, the shared cron/storage/streams modules, config params, secrets, builds
    • testing.mdmockService, bootstrapService, the /fake entry-point pattern
    • deploying.md — stages, destroy semantics, CI, production behavior (gotchas-derived)

Agent skill

One self-contained skill, skills/prisma-composer/, replaces the deploying-prisma-apps + testing-prisma-apps pair and adds the missing authoring story, so npx skills add prisma/composer --skill prisma-composer gives an agent the whole write-test-deploy workflow in one install. skills/README.md records the install command, the authoring rules, and that the guides are canonical (a surface change lands in both).

Shaping decisions (operator-settled): one skill, not a prisma-next-style ten-skill cluster — Composer's surface is small enough; guides/skill duplication is accepted because the audiences differ; describe only what ships.

Fixes riding along:

  • skill folder names now match frontmatter names (the runtimes key on frontmatter; the old folders said prisma-apps, the frontmatter said prisma-composers — stale vocabulary)
  • no skill link resolves outside the skill folder (the old testing skill linked ../../docs/design/..., which dangles once installed into another repo)
  • standaloneEntryPath corrected to standaloneServerPath — the export that actually ships

Verification

  • Every @prisma/* import and symbol in the skill and guides checked against the packages/9-public/* export maps and source barrels while drafting; CLI flags checked against packages/0-framework/3-tooling/cli/src/main.ts.
  • Trial install end-to-end: npx skills add file://<repo> --skill prisma-composer -a claude-code -y into a scratch project copies the skill to .claude/skills/prisma-composer/.
  • Every relative link in README + guides script-checked against the tree; ADR links use the real filenames.
  • lint:framework-vocabulary clean.

🤖 Generated with Claude Code

…-skill set

Merge deploying-prisma-apps and testing-prisma-apps into a single
self-contained skill, skills/prisma-composer, and add the missing
authoring story: the mental model, contracts, the root module, builds,
deploy config, databases (postgres/pnPostgres), reusable modules
(cron/storage/streams), config params, secrets, and production pitfalls,
plus an honest list of what Composer doesn't do yet.

Fixes carried by the merge:
- folder names now match frontmatter names (the runtimes key on
  frontmatter; the old folders said prisma-apps, the frontmatter said
  prisma-composers)
- no link resolves outside the skill folder (the old testing skill
  linked ../../docs/design, which dangles once installed into another
  repo)
- standaloneEntryPath corrected to standaloneServerPath (the export
  that actually ships)

skills/README.md documents the install command and the authoring rules
(verify every claim against packages/ while drafting; self-contained;
concepts over procedures).

Signed-off-by: willbot <w.a.madden+machine@gmail.com>
Signed-off-by: Will Madden <madden@prisma.io>
@pkg-pr-new

pkg-pr-new Bot commented Jul 15, 2026

Copy link
Copy Markdown

Open in StackBlitz

npm i https://pkg.pr.new/@prisma/composer@90
npm i https://pkg.pr.new/@prisma/composer-prisma-cloud@90

commit: 9d3c7b5

Reorient the root README toward people building apps on Composer: what
a service and a root module look like, the real examples/store topology
in place of the aspirational diagram, a guides table, an examples table,
and the agent-skill install. Design docs move to a "Design & internals"
section for contributors. Everything described is shipped surface —
unshipped design (stream connections, shared-Postgres contract slices,
topology artifact queries) is no longer presented as current.

Four guides, canonical for humans (the skill is the agent-condensed
mirror; skills/README.md now says so):

- getting-started.md — empty directory to a deployed two-service app
- building-an-app.md — contracts, databases, Modules, shared modules,
  params, secrets, builds
- testing.md — mockService / bootstrapService / the /fake pattern
- deploying.md — stages, destroy, CI, production behavior

All relative links checked against the tree; ADR links use the real
filenames.

Signed-off-by: willbot <w.a.madden+machine@gmail.com>
Signed-off-by: Will Madden <madden@prisma.io>
@wmadden-electric wmadden-electric changed the title docs(skills): one installable prisma-composer skill replacing the two-skill set docs: consumer docs (README + guides) and one installable prisma-composer skill Jul 15, 2026
Fresh-eyes rewrite of the README and all four guides, targeting a
teammate who does not know Composer but wants to build or port an app
onto Prisma Cloud, probably with Prisma Next.

- README: opens with what the tool does and when it earns its keep
  (multi-piece apps), instead of category language; names the porting
  path.
- getting-started: adds "Run it locally" (COMPOSER_* env vars —
  verified by actually running the cron example services locally and
  curling them) and a "Porting an existing app" section (Node/Bun
  service, Next.js app, multi-service); explains why Bun; says where
  the two deploy credentials come from.
- building-an-app: reader-oriented opening (was a fragment); the
  Prisma Next database section now spells out the schema-change
  workflow (contract.prisma -> contract emit -> migration plan ->
  deploy applies); design-doc phrasing translated into reader benefit;
  ADR citations moved out of sentence flow into a closing
  "Digging deeper" list.
- testing: says when to pick which seam; example is a complete
  runnable Vitest test with its imports.
- deploying: explains deploy state and locking in plain terms; says
  where credentials come from; pitfalls phrased as what-you-hit ->
  what-to-do.

All relative links and intra-guide anchors script-checked;
vocabulary lint clean.

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.

1 participant