writing-docs

Write and edit Remotion documentation with structured MDX guidelines.

55.9k|4.2k|Updated Jun 23, 2020
One-click install
npx skills add https://github.com/remotion-dev/remotion --skill writing-docs-remotion-dev
Or copy as Structured Prompt for Agent
Please help me install this Agent Skill.
Skill: writing-docs
Source: https://github.com/remotion-dev/remotion/tree/main/.claude/skills/writing-docs
Command: npx skills add https://github.com/remotion-dev/remotion --skill writing-docs-remotion-dev

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve?

Documentation consistency across Remotion pages is hard to achieve. This Skill provides a concise, opinionated guide to writing and editing Remotion documentation to ensure clarity, accuracy, and uniform expectations.

Core Features & Use Cases

  • Guidelines for adding new pages in packages/docs
  • Rules for editing MDX files and maintaining terminology
  • Clear, repeatable workflow for documentation tasks across the project

Quick Start

Use this Skill to draft a new Remotion docs page following the guidelines above.

Frequently Asked Questions about writing-docs

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

FAQPage Schema
How do I write Remotion documentation in MDX?

To write Remotion documentation, author MDX files in packages/docs and follow the structured frontmatter schema and Markdown styling rules. This ensures documentation clarity, accuracy, and uniform terminology across all project pages.

What are the frontmatter requirements for Remotion docs pages?

Remotion docs pages require a specific frontmatter schema enforced by the documentation workflow. Maintainers must apply this structured schema when adding new pages in packages/docs to maintain consistent metadata and styling.

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

Adding a new documentation page involves creating an MDX file in packages/docs and applying the enforced frontmatter schema. Following the project's Markdown styling rules and terminology guidelines ensures the page integrates cleanly into the Remotion docs workflow.

Does the Remotion docs workflow enforce specific Markdown styling rules?

Yes, the Remotion documentation workflow enforces clear Markdown styling and terminology rules. These guidelines ensure consistent content formatting and accurate documentation structure across all MDX files added to the project.

Why does Remotion documentation require a structured writing guide?

Remotion documentation requires a structured writing guide to solve the problem of consistency across multiple docs pages. It provides an opinionated set of rules for editing MDX files, ensuring clarity, accuracy, and uniform formatting expectations for all maintainers.

Can I edit existing MDX documentation without following the frontmatter schema?

No, editing existing Remotion MDX files requires maintaining the enforced frontmatter schema and terminology rules. Consistent application of these documentation guidelines ensures all content remains clear and accurately structured across the project.