writing-docs

SKILL.md

Guidelines and templates for writing Remotion API documentation in MDX format.

Create one .mdx file per API in packages/docs/docs, add it to sidebars.ts, and run bun render-cards.ts to generate social preview cards

Use ### headings for API properties (not bullet points), add ? suffix for optional parameters, and include default values naturally in descriptions

Prefer type-safe code snippets with twoslash validation; use // ---cut--- to hide imports and always add title attributes to example blocks

Link Remotion-specific terms to the terminology page, keep language brief and direct, avoid filler words, and address readers as "you"

Use special components like <AvailableFrom>, <CompatibilityTable>, <ExperimentalBadge>, and <Step> for version indicators, compatibility matrices, warnings, and numbered lists

Writing Remotion Documentation

Documentation lives in packages/docs/docs as .mdx files.

Adding a new page

Create a new .mdx file in packages/docs/docs

Add the document to packages/docs/sidebars.ts

Write the content following guidelines below

Run bun render-cards.ts in packages/docs to generate social preview cards

Breadcrumb (crumb): If a documentation page belongs to a package, add crumb: '@remotion/package-name' to the frontmatter. This displays the package name as a breadcrumb above the title.