Folders and files
| Name | Name | Last commit date | ||
|---|---|---|---|---|
parent directory.. | ||||
The docs app is a Next.js site in the monorepo. All commands below assume you’re in the repository root unless noted.
# From repo root: install deps for all workspaces
pnpm install
# Run the docs app (and other apps via Turbo)
pnpm devOpen http://localhost:3001 in your browser.
pnpm --filter docs devpnpm --filter docs buildThe build runs fetch-openapi before next build to pull the latest Management API spec.
pnpm devTurbo runs dev for every app in parallel (site on 3000, docs on 3001, blog on 3002, eclipse on 3003).
| Path | Purpose |
|---|---|
| apps/docs/content/docs/ | Docs content, including latest pages and versioned ORM content under orm/v6/ |
| apps/docs/source.config.ts | Fumadocs config (collections, meta, plugins) |
| apps/docs/cli.json | CLI reference data |
Sidebar and structure come from meta.json in each folder. See Fumadocs collections for details.
Run these from the repo root with pnpm --filter docs <script>:
| Script | Description |
|---|---|
| lint:links | Validate internal and external links |
| lint:code | Lint code blocks in MDX |
| lint:spellcheck | Spell-check content |
| fetch-openapi | Fetch Management API OpenAPI spec (runs automatically before build) |
The docs app uses workspace packages:
- @prisma/eclipse — design system components
- @prisma-docs/ui — shared UI components, utilities, and config
If you change those packages, rebuild or run them in watch mode so docs sees updates.
- Use the (docs) scope in commit messages when changes are docs-only: feat(docs): update getting started
- Run lint/build for affected workspaces before pushing
- See CONTRIBUTING.md for full workflow and commit rules