Writing Docs

This is a comprehensive style guide for writing Remotion's API documentation, covering everything from file structure to voice and tone. You'll want this when documenting React components, CLI tools, or any public API in the Remotion ecosystem. The guidelines are opinionated in useful ways: one API per page, headings for every parameter instead of bullet lists, type-checked code snippets using twoslash, and strict rules about optional parameters. It includes MDX components for version badges, compatibility tables, and interactive demos. The language section is particularly solid, pushing for brevity and discouraging assumptions about difficulty. If you're maintaining technical docs for a TypeScript library, you could adapt most of this directly.

Install to Claude Code

npx -y skills add remotion-dev/remotion --skill writing-docs --agent claude-code