writing-docs

Guides writing and editing Remotion documentation MDX pages with formatting conventions.

Updated May 15, 2026
One-click install
npx skills add https://github.com/danielbere1973/promoar --skill writing-docs-danielbere1973
Or copy as Structured Prompt for Agent▼
Please help me install this Agent Skill.
Skill: writing-docs
Source: https://github.com/danielbere1973/promoar/tree/main/.agents/skills/writing-docs
Command: npx skills add https://github.com/danielbere1973/promoar --skill writing-docs-danielbere1973

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve? Writing consistent, well-structured documentation for Remotion requires following many specific conventions for MDX formatting, code snippets, components, and page structure. This Skill encodes all of those rules so documentation pages are written correctly the first time. ## Core Features & Use Cases - Page Creation Workflow: Guides adding new .mdx pages in packages/docs/docs, registering them in sidebars.ts, and generating social preview cards with render-cards.ts. - Formatting Conventions: Enforces rules like one API per page, headings for fields, breadcrumb crumbs, and language guidelines (brief, "you"-addressed, no filler). - Special Components: Covers twoslash type-safe code snippets, Steps, ExperimentalBadge, AvailableFrom version indicators, and CompatibilityTable usage. - Use Case: When adding documentation for a new Remotion API like a hook or component, use this Skill to produce a compliant MDX page with proper frontmatter, typed code examples, and version badges, then verify it builds with bun run build-docs. ## Quick Start Write a new documentation page for the useCurrentFrame hook following the Remotion docs guidelines.

Frequently Asked Questions about writing-docs

High-intent search queries and answers about installing and using this skill.

FAQPage Schema
How do I add a new documentation page in Remotion?▼

Create a new .mdx file in packages/docs/docs, register it in packages/docs/sidebars.ts, and write content following the formatting guidelines. Afterward, run bun render-cards.ts in packages/docs to generate social preview cards.

How do I write type-safe code snippets in MDX documentation?▼

Add twoslash to the code fence language tag, such as ```ts twoslash, so snippets are checked against TypeScript. Use // ---cut--- to hide setup imports and add a title attribute for example usage blocks.

How do I show which version a Remotion feature was added in?▼

Use the globally available AvailableFrom component inline with a heading, such as # <MyComponent><AvailableFrom v="4.0.123" />. Escape angle brackets in component names with &lt; and &gt;.

How do I verify Remotion documentation builds without errors?▼

Run bun run build-docs from the monorepo root. This validates MDX syntax, twoslash code snippets, and broken links across the documentation site.

Should multiple APIs be documented on one page?▼

No, each function or API gets its own dedicated documentation page. Combining multiple APIs on a single page violates the documentation guidelines, and only public APIs should be documented.