Can I use this for documenting internal Remotion APIs?

No, this skill follows the guideline that documentation is strictly for public APIs only and should not reference internal implementation details.

Does this skill help with site navigation?

Yes, it reminds you to add any new documentation pages to the packages/docs/sidebars.ts file to ensure they are visible in the sidebar.

How do I indicate which version introduced a feature?

The skill instructs you to use the component within headings or inline text to provide clear versioning history.

What is the 'One API per page' rule?

This rule ensures that every function or API has a dedicated documentation page to improve searchability and prevent information overload.

How does this skill handle code snippets?

It promotes the use of twoslash for compile-time type checking and provides instructions for using the // ---cut--- syntax to hide boilerplate imports from the rendered view.

Remotion Documentation Specialist

Name: Remotion Documentation Specialist
Author: remotion-dev

byremotion-dev

•

28,578

•

Content Management

Streamlines the creation and maintenance of high-quality MDX technical documentation for the Remotion ecosystem.

The Remotion Documentation Specialist skill provides specialized guidance for contributing to Remotion's documentation, ensuring strict consistency across MDX files, API references, and code examples. It enforces domain-specific standards such as the 'one API per page' policy, 'twoslash' type-safety for snippets, and the correct application of custom components like version badges and interactive demos. By automating the application of Remotion's specific voice and style guidelines—focusing on brevity and developer-centric clarity—it helps contributors produce professional, technically accurate documentation that integrates perfectly into the packages/docs structure.

Key Features

01Guides usage of custom MDX components like Steps, ExperimentalBadges, and Demos

02Enforces 'One API per page' architectural standards for technical docs

03Integrates TypeScript type-checking via twoslash in MDX snippets

04Automates formatting for API parameters, optional fields, and versioning

05Standardizes documentation tone to be brief, objective, and user-focused

0628,578 GitHub stars

Use Cases

01Adding comprehensive documentation for a new Remotion public API or function

02Generating type-safe code examples with hidden setup code using the cut pattern

03Refactoring existing .mdx files to comply with the latest style and terminology rules

Key Features

01Guides usage of custom MDX components like Steps, ExperimentalBadges, and Demos

02Enforces 'One API per page' architectural standards for technical docs

03Integrates TypeScript type-checking via twoslash in MDX snippets

04Automates formatting for API parameters, optional fields, and versioning

05Standardizes documentation tone to be brief, objective, and user-focused

0628,578 GitHub stars

Use Cases

01Adding comprehensive documentation for a new Remotion public API or function

02Generating type-safe code examples with hidden setup code using the cut pattern

03Refactoring existing .mdx files to comply with the latest style and terminology rules