writing-docs

Guide authors in writing Remotion documentation with consistent MDX structure.

Updated Aug 23, 2026
One-click install
npx skills add https://github.com/Animesh-Kr/claude-skills --skill writing-docs-animesh-kr
Or copy as Structured Prompt for Agent
Please help me install this Agent Skill.
Skill: writing-docs
Source: https://github.com/Animesh-Kr/claude-skills/tree/main/remotion-main/.claude/skills/writing-docs
Command: npx skills add https://github.com/Animesh-Kr/claude-skills --skill writing-docs-animesh-kr

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve?

Guides developers to write and edit Remotion documentation with consistent structure and quality across the project.

Core Features & Use Cases

  • Provides guidelines for adding docs pages, editing MDX files in packages/docs, and maintaining documentation content.
  • Enforces frontmatter metadata and page structure to ensure discoverability and consistency.
  • Outlines recommended workflows for generating social previews and verifying builds.

Quick Start

Draft a new Remotion docs page by following the frontmatter, section structure, and style guidelines outlined above.

Frequently Asked Questions about writing-docs

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

FAQPage Schema
How do I structure frontmatter for new Remotion documentation pages?

Remotion documentation frontmatter requires specific metadata fields to enforce page discoverability and structural consistency across the project's MDX files.

What's the best way to edit MDX content in the packages/docs directory?

Editing MDX content in packages/docs involves following established guidelines for frontmatter, section structure, and style to maintain consistent, high-quality documentation across the project.

What steps are needed to verify Remotion docs builds and generate social previews?

Verifying Remotion docs builds and generating social previews requires following the recommended workflows outlined in the documentation guidelines to ensure reliable and searchable output.

Why does my Remotion documentation lack consistency and searchability?

Documentation lacks consistency when authors bypass frontmatter requirements and section structure guidelines, which are enforced to solve low-quality Remotion docs and ensure reliable searchability.

Do I need to follow specific section structures when writing Remotion docs?

Yes, writing Remotion docs requires following specific section structure guidelines to maintain quality and consistency across all newly created and edited documentation pages.