writing-docs
/writing-docs
Guides for writing and editing Remotion documentation. Use when adding docs pages, editing MDX files in packages/docs, or writing documentation content.
- Author
- foryourhealth111-pixel ↗
- Repository
- Vibe-Skills ↗
- Licence
- Apache-2.0
- Last repository change
- 25.10.2026
Assessment and security
- Files in this package
- 1
- Scripts
- 0
- HTML comments
- 0
- URLs in SKILL.md
- 0
No signals detected. Repository changed on 25.10.2026, without references to retired models or APIs.
Apache-2.0, otwarta: można używać i zmieniać, z zachowaniem licencji i informacji o zmianach.
What it does and when to use it
Guides for writing and editing Remotion documentation. Use when adding docs pages, editing MDX files in packages/docs, or writing documentation content.
Original author description
Guides for writing and editing Remotion documentation. Use when adding docs pages, editing MDX files in packages/docs, or writing documentation content.
How it works
- Adding a new page
- Language guidelines
- Code snippets
- Special components
- Generating preview cards
- Verifying docs compile
SKILL.md preview
---
name: writing-docs
description: Guides for writing and editing Remotion documentation. Use when adding docs pages, editing MDX files in packages/docs, or writing documentation content.
---
# Writing Remotion Documentation
Documentation lives in `packages/docs/docs` as `.mdx` files.
## Adding a new page
1. Create a new `.mdx` file in `packages/docs/docs`
2. Add the document to `packages/docs/sidebars.ts`
3. Write the content following guidelines below
4. Run `bun render-cards.ts` in `packages/docs` to generate social preview cards
**One API per page**: Each function or API should have its own dedicated documentation page. Do not combine multiple APIs (e.g., `getEncodableVideoCodecs()` and `getEncodableAudioCodecs()`) on a single page. This is the established pattern throughout the codebase.
**Public API only**: Documentation is for public APIs only. Do not mention, reference, or compare against internal/private APIs or implementation details. Users should only see what is exported and intended for public use.
**Use headings for all fields**: When documenting API options or return values, each property should be its own heading. Use `###` for top-level properties and `####` for nested properties within an options object. Do not use bullet points for individual fields.
## Language guidelines
- **Keep it brief**: Developers don't like to read. Extra words cause information loss.
- **Link to terminology**: Use [terminology](/docs/terminology) page for Remotion-specific terms.
- **Avoid emotions**: Remove filler like "Great! Let's move on..." - it adds no information.
- **Separate into paragraphs**: Break up long sections.
- **Address as "you"**: Not "we".
- **Don't blame the user**: Say "The input is invalid" not "You provided wrong input".
- **Don't assume it's easy**: Avoid "simply" and "just" - beginners may struggle.
## Code snippets
Basic syntax highlighting:
````md
```ts
const x = 1;
```
````
### Type-safe snippets (preferred)
Use `twoslash` to check snippets against TypeScript:
````md
```ts twoslash
import {useCurrentFrame} from 'remotion';
const frame = useCurrentFrame();
```
````
### Hiding imports
Use `// ---cut---` to hide setup code - only content below is displayed:
````md
```ts twoslash
import {useCurrentFrame} from 'remotion';
// ---cut---
const frame = useCurrentFrame();
```
````
### Adding titles
````md
```ts twoslash title="MyComponent.tsx"
console.log('Hello');
```
````
## Special components
### Steps
```md
- <Step>1</Step> First step
- <Step>2</Step> Second step
```
### Experimental badge
```md
<ExperimentalBadge>
<p>This feature is experimental.</p>
</ExperimentalBadge>
```
### Interactive demos
```md
<Demo type="rect"/>
```
Demos must be implemented in `packages/docs/components/demos/index.tsx`.
## Generating preview cards
After adding or editing a page, generate social media preview cards:
```bash
cd packages/docs && bun render-cards.ts
```
## Verifying docs compile
To check that documentation builds without errors:
```bash
# from the monorepo root
bun run build-docs
```
This validates MDX syntax, twoslash snippets, and broken links.
Versions
| Repository | Score | Licence |
|---|---|---|
| This page · foryourhealth111-pixel/Vibe-Skills | 100 | Apache-2.0 |
| smarzban/agent-skills | 100 | MIT |
| remotion-dev/remotion | 100 | MIT |
| nukeop/nuclear | 100 | AGPL-3.0 |
| it-bens/ai-tools | 100 | MIT |
| jamescai-md/motionframe-edit | 100 | MIT |
| MoizIbnYousaf/marketing-cli | 100 | MIT |
| spgsroot/omp-agent-skills | 90 | MIT |
Identical content appears in 1 other GitHub folders. We show one copy with the highest score.
Database snapshot: 13.11.2026 · package version 91e3b427c650 (SHA-256 digest of the entire package)
Downloads in the last 30 days: 1 · ranking
Report a problem with this skill: harmful content, incorrect descriptions or an author’s removal request.
Similar skills
- 100technical-docs
Write and review technical documentation for Sentry SDK docs. Use when creating, editing, or reviewing documentation pages, especially MDX files in docs/platforms/. - 100qwik-docs-development
Use when writing, modifying, or reviewing Qwik docs content or docs-site code under packages/docs, including docs routes, MDX content, generated LLM outputs, docs build behavior, or docs-specific e2e tests. - 90write-docs
Write or revise QUI Docs documentation. Use whenever Codex is creating, editing, restructuring, or expanding MDX route files, navigation entries, documentation links, examples, screenshots, or docs assets in packages/docs/qui-docs or any QUI Docs-based documentation site; also… - 100update-docs
This skill should be used when the user asks to "update documentation for my changes", "check docs for this PR", "what docs need updating", "sync docs with code", "scaffold docs for this feature", "document this feature", "review docs completeness", "add docs for this change",… - 100docs-write
Write documentation following Metabase's conversational, clear, and user-focused style. Use when creating or editing documentation files (markdown, MDX, etc.). - 100fumadocs-mdx-structure
Create MDX documentation files with proper frontmatter, imports, and component integration. Apply when creating or updating Fumadocs documentation pages in content/docs/.