README.md
This repository is a pnpm monorepo containing the Prisma documentation, blog, design system docs, and shared packages.
| Path | Description |
|---|---|
apps/docs | Prisma documentation site (Next.js + Fumadocs) |
apps/blog | Prisma blog |
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.
New contributors are welcome. Read the contributing guide before submitting changes.
From the repository root:
pnpm install
pnpm dev
This starts all apps via Turbo:
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 build
To 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 |
apps/docs/content/docs/ (latest), apps/docs/content/docs.v6/ (versioned). Sidebar structure comes from meta.json in each folder. See Fumadocs collections.apps/blog/content/blog/ (MDX with authors, dates, hero images).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.