skills.rest
hugotown
hugotownCOMMUNITY
Explore all skills by this author →
WebsiteGitHub

writing-docs

Guides writing and editing Remotion documentation pages in MDX format.

Updated Oct 16, 2025
Search Tags:#documentation#technical writing#api docs#mdx#docusaurus#remotion#twoslash
One-click install
npx skills add https://github.com/hugotown/dotfiles --skill writing-docs-hugotown
Or copy as Structured Prompt for Agent▼
Please help me install this Agent Skill.
Skill: writing-docs
Source: https://github.com/hugotown/dotfiles/tree/main/agents/skills/writing-docs
Command: npx skills add https://github.com/hugotown/dotfiles --skill writing-docs-hugotown

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve? Writing consistent, well-structured documentation for the Remotion project requires following many specific conventions, from MDX formatting and sidebar registration to type-safe code snippets and version badges. This Skill encodes all of those rules so contributors produce compliant docs pages on the first attempt. ## Core Features & Use Cases - Page authoring workflow: Create new .mdx pages in packages/docs/docs, register them in sidebars.ts, and generate social preview cards with bun render-cards.ts. - Documentation conventions: Enforces one-API-per-page structure, heading-based field documentation, breadcrumb crumbs, and language guidelines such as addressing readers as "you" and avoiding filler words. - Rich components and snippets: Covers twoslash type-checked code blocks, Steps, ExperimentalBadge, Demo, AvailableFrom version indicators, and CompatibilityTable usage. - Use Case: When adding documentation for a new Remotion API, use this Skill to scaffold the MDX page with correct frontmatter, optional-parameter headings, compatibility tables, and then verify the docs build with bun run build-docs. ## Quick Start Ask the assistant to write a new Remotion documentation page for a specific API following the writing-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, write the content following the language guidelines, then 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 the twoslash annotation to a ts code fence so snippets are checked against TypeScript. Use // ---cut--- to hide setup imports and add a title attribute to code fences showing example usage.

How do I document optional parameters in API docs?▼

Add a question mark to the parameter heading, such as ### onError?, and mention the default value naturally in the description. Do not add separate _optional_ text, and skip the question mark for CLI flags since they are always optional.

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

Use the globally available AvailableFrom component inline with a heading, for example # <MyComponent><AvailableFrom v="4.0.123" />. For parameters that became optional later, write Optional since <AvailableFrom v="5.0.0" inline />.

How do I verify Remotion documentation builds without errors?▼

Run bun run build-docs from the monorepo root. This validates MDX syntax, type-checks twoslash snippets, and detects 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, and docs must cover public APIs only without referencing internal implementation details.

Related Skills

Explore More Software Engineering Skills→
wahidyankfwahidyankf
3

docs-validating-factual-accuracy

Validate technical documentation claims against authoritative sources with confidence labels.

Community
Intermediate
Grupo-AFALGrupo-AFAL

add-docs-site

Scaffold an Astro Starlight documentation site into a Rails application.

Official
Advanced
PionpillPionpill
12

docs-doc-component

Standardize Retikz component documentation with a six-section structure and API table format.

Community
Basic
nashirabbashnashirabbash

write-api-reference

Generate MDX API reference pages for Next.js APIs from source or specifications.

Community
Advanced