Back to Prisma

Prisma Documentation

apps/docs/README.md

latest2.3 KB
Original Source

Prisma Documentation

The docs app is a Next.js site in the monorepo. All commands below assume you’re in the repository root unless noted.


Quick start

bash
# From repo root: install deps for all workspaces
pnpm install

# Run the docs app (and other apps via Turbo)
pnpm dev

Open http://localhost:3000 in your browser.


Working from the monorepo root

Run docs only

bash
pnpm --filter docs dev

Build docs only

bash
pnpm --filter docs build

The build runs fetch-openapi before next build to pull the latest Management API spec.

Run all apps

bash
pnpm dev

Turbo runs dev for every app in parallel (docs on 3000, blog on 3001, eclipse on 3002).


Content and structure

PathPurpose
apps/docs/content/docs/Latest version docs (MDX)
apps/docs/content/docs.v6/V6 versioned docs
apps/docs/source.config.tsFumadocs config (collections, meta, plugins)
apps/docs/cli.jsonCLI reference data

Sidebar and structure come from meta.json in each folder. See Fumadocs collections for details.


Scripts

Run these from the repo root with pnpm --filter docs <script>:

ScriptDescription
lint:linksValidate internal and external links
lint:codeLint code blocks in MDX
lint:spellcheckSpell-check content
fetch-openapiFetch Management API OpenAPI spec (runs automatically before build)

Dependencies

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.


Contributing

  • 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