writing-docs

Document writing and editing guidelines for Remotion MDX documentation.

Updated Aug 23, 2026
One-click install
npx skills add https://github.com/takarki/Geminizer --skill writing-docs-takarki
Or copy as Structured Prompt for Agent
Please help me install this Agent Skill.
Skill: writing-docs
Source: https://github.com/takarki/Geminizer/tree/main/0030_remotion-main_20260121/.claude/skills/writing-docs
Command: npx skills add https://github.com/takarki/Geminizer --skill writing-docs-takarki

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve?

Documentation quality and consistency across Remotion's MDX docs can be inconsistent. This guide helps teams write, review, and edit docs with a unified structure and terminology.

Core Features & Use Cases

  • Standardized page templates and API documentation conventions.
  • Guidelines for editing MDX content in packages/docs and cross-referencing terminology.
  • Use cases include adding new docs pages, updating existing content, and validating previews after changes.

Quick Start

Edit or create a new MDX page under packages/docs/docs, follow the style guidelines in this document, and run the docs rendering process to verify previews.

Frequently Asked Questions about writing-docs

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

FAQPage Schema
How do I write consistent Remotion documentation in MDX?

To write Remotion documentation, use standardized MDX page templates and API conventions to maintain consistent structure and terminology across packages/docs pages.

What's the best way to structure new MDX pages for Remotion docs?

The best way to structure MDX pages is using the standardized page templates provided for Remotion documentation. This ensures unified terminology and proper content structure across all new pages.

How do I add a new documentation page to packages/docs?

To add a documentation page, create a new MDX file under packages/docs/docs, apply the style guidelines, and run the docs rendering process to validate the preview.

How do I validate MDX content previews after editing Remotion docs?

To validate MDX content previews, run the documentation rendering process after editing your MDX pages. This verifies that your content updates display correctly before finalizing changes.

Why do my Remotion API reference pages have inconsistent terminology?

Inconsistent terminology in API reference pages occurs without standardized writing guidelines. This guide provides unified conventions to cross-reference and standardize terms across packages and docs.