apps/docs

Active contributors: Steve Ruiz, Lu Wilson, Mime Čuvalo, Taha

Purpose

apps/docs/ is the Next.js site behind https://tldraw.dev. It hosts the SDK reference docs, the conceptual articles, the examples gallery, the release notes, and the marketing pages.

Directory layout

apps/docs/
├── package.json
├── next.config.js
├── tailwind.config.js
├── content.d.ts                  # types for the MDX content
├── watcher.ts
├── tsconfig.content.json
├── app/                          # Next App Router routes
├── components/                   # React components
├── content/                      # MDX content (articles, examples, release notes)
├── public/                       # static assets
├── scripts/                      # build/codegen helpers
├── types/
└── utils/

Content

apps/docs/content/ is the source of truth for SDK documentation. The structure mirrors the docs site's navigation: docs/, examples/, releases/, etc. MDX files are typed by content.d.ts and rendered through the App Router.

The release notes file apps/docs/content/releases/next.mdx is updated continuously between releases (it is one of the most-changed files in the last 90 days). When a release ships, it is renamed/archived and a new next.mdx is started.

Tooling

• Built with Next.js (latest), Tailwind, and MDX.
• Uses @lingual/i18n-check to validate translation keys.
• Search and ranking lower-cased into the Next App Router routes; see apps/docs/scripts/.
• The Mermaid integration uses packages/mermaid.
• Framer rewrites are added by apps/docs/scripts/add-framer-rewrites.ts (see yarn add-framer-rewrites).

How it works

graph LR
    MDX[content/*.mdx] -->|build-docs| Next[Next.js build]
    Next --> Site[tldraw.dev]
    APIReports[packages/*/api-report.api.md] -->|generate-api-content| MDX

API reference content is generated from the api-report.api.md files emitted by api-extractor. The build pipeline ensures docs and code can't drift.

Integration points

• Imports. tldraw, @tldraw/state, plus standard Next/MDX dependencies.
• Importers. None — apps/docs is a leaf.

Related

• Apps
• skills/write-docs
• skills/write-release-notes