This repository is a pnpm monorepo containing the Prisma documentation, blog, design system docs, and shared packages.
| Path | Description |
|---|---|
apps/site |
Main Prisma website |
apps/docs |
Prisma documentation site (Next.js + Fumadocs) |
apps/blog |
Prisma blog |
apps/handbook |
Builders Handbook (Next.js + Fumadocs), chapters written by Shane, see apps/handbook/AUTHORING.md |
apps/eclipse |
Eclipse design system documentation |
packages/eclipse |
Eclipse design system component library (@prisma/eclipse) |
packages/ui |
Shared UI components and utilities (@prisma-docs/ui) |
See each appโs README.md for more detail.
See ARCHITECTURE.md for the cross-app multi-zone overview.
New contributors are welcome. Read the contributing guide before submitting changes.
From the repository root:
pnpm install
pnpm devThis builds and runs the combined Composer app locally. Open the gateway URL
printed by Composer; it serves the site at /, docs at /docs, blog at /blog,
handbook at /handbook, and Eclipse at /eclipse. No cloud credentials are needed.
See COMPOSER.md for resource budgets, configuration, and the build loop,
and COMPOSER_FINDINGS.md for the findings from this port.
For the original Next.js HMR workflow, run pnpm dev:turbo. Its individual app ports
remain 3000 (site), 3001 (docs), 3002 (blog), 3003 (Eclipse), and 3004 (handbook).
To run a single app:
pnpm --filter docs dev # docs only
pnpm --filter blog dev # blog only
pnpm --filter eclipse dev # eclipse design system docs only
pnpm --filter handbook dev # builders handbook onlypnpm buildTo build and serve the docs site:
pnpm --filter docs build
pnpm --filter docs start| Script | Description |
|---|---|
pnpm lint:links |
Validate internal and external links (docs) |
pnpm lint:code |
Lint code blocks in MDX (docs) |
pnpm lint:spellcheck |
Spell-check content (docs) |
pnpm check |
Run formatting and lint fixes across all workspaces |
- Docs โ
apps/docs/content/docs/(latest),apps/docs/content/docs.v6/(versioned). Sidebar structure comes frommeta.jsonin each folder. See Fumadocs collections. - Blog โ
apps/blog/content/blog/(MDX with authors, dates, hero images). - Eclipse โ
apps/eclipse/content/design-system/(component docs).
.md and .mdx files are not formatted by Prettier because they use MDX 3, which Prettier does not support. See prettier/prettier#12209.