Programowanie · Pisanie
writing-docs
/writing-docs
Podpowiada, jak pisać i edytować dokumentację Remotion, w tym strony MDX w pakiecie docs.
- Autor
- jamescai-md ↗
- Repozytorium
- motionframe-edit ↗
- Licencja
- MIT
- Ostatnia zmiana repozytorium
- 08.11.2026
Ocena i bezpieczeństwo
100/ 100Klasa: dobry
Format25 / 25
Frontmatter z nazwą i opisem, poprawna nazwa, opis do 1024 znaków, nazwa zgodna z folderem.
Odkrywalność25 / 25
Opis mówi, kiedy użyć skilla, ma sensowną długość i jest w 3. osobie.
Treść35 / 35
Co najmniej 150 słów i do 500 linii, nagłówki, listy kroków, przykłady albo kod.
Higiena15 / 15
Bez zaślepek typu TODO, bez ścieżek Windows, z licencją.
Ryzykobrak sygnałów w skanie
- Pliki w paczce
- 1
- Skrypty
- 0
- Komentarze HTML
- 0
- Adresy URL w SKILL.md
- 2
Przestarzałość
Brak sygnałów. Repozytorium zmienione 08.11.2026, bez odwołań do wycofanych modeli i API.
Licencja
MIT, otwarta: można używać i zmieniać, z zachowaniem informacji o autorze.
Co robi i kiedy
Podpowiada, jak pisać i edytować dokumentację Remotion, w tym strony MDX w pakiecie docs.
Oryginalny opis (EN)
Guides for writing and editing Remotion documentation. Use when adding docs pages, editing MDX files in packages/docs, or writing documentation content.
Jak działa
- Adding a new page
- Language guidelines
- Code snippets
- Special components
- Generating preview cards
- Streamlining existing docs
Sekcje z nagłówków SKILL.md, w oryginale · 220 linii, 1 056 słów
Podgląd SKILL.md
---
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
**Breadcrumb (`crumb`)**: If a documentation page belongs to a package, add `crumb: '@remotion/package-name'` to the frontmatter. This displays the package name as a breadcrumb above the title.
```md
---
image: https://remotion.media/docs/generated/articles-docs-my-package-my-api.png
title: '<MyComponent>'
crumb: '@remotion/my-package'
---
```
**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.
**Public API only**: Documentation is for public APIs only. Do not mention, reference, or compare against internal/private APIs or implementation details.
**API names in prose**: Put API names in backticks, and link them if a docs page exists. Function and hook names should include `()`, for example [`useVideoConfig()`](/docs/use-video-config), not `useVideoConfig` or useVideoConfig. Components should include angle brackets, for example [`<Player>`](/docs/player/player) or [`<Audio>`](/docs/media/audio).
**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.
**Version indicators**: If an API, feature, parameter, or behavior was added in a specific version, add `<AvailableFrom>` at the page, section, or field where the reader first needs to know it. For example: `# prefetch()<AvailableFrom v="4.0.0" />`.
**Compatibility tables**: API pages should ideally include a `## Compatibility` section with `<CompatibilityTable>` before `## See also`.
**Sidebar order**: When adding or moving docs in `packages/docs/sidebars.ts`, inspect the surrounding entries and match the ordering logic already used there. If a section is alphabetical, place the new entry alphabetically; if it is grouped by workflow or importance, place it consistently with that grouping. Do not leave new additions as one-off outliers.
## 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.
- **Do not bold terms**: Write terms as plain text, code spans, or links as appropriate. Do not use bold formatting to introduce a term.
- **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
Always add a `title` to code fences that show example usage:
````md
```ts twoslash title="MyComponent.tsx"
console.log('Hello');
```
````
## Special components
### Steps
Keep one `<Step>` per line and add a space after `</Step>`. Use an explicit line break (`<br/>` or `<br />`) when consecutive steps should appear on separate lines. Do not add Markdown bullet markers solely to wrap steps in a `<ul>`.
```md
<Step>1</Step> First step<br />
<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`. See the `docs-demo` skill for details on adding new demos.
### AvailableFrom
Use to indicate when a feature or parameter was added. No import needed - it's globally available.
**For page-level version indicators**, use an `# h1` heading with `<AvailableFrom>` inline so it appears next to the title (not below it). Use `<` and `>` to escape angle brackets in component names:
```md
# <MyComponent><AvailableFrom v="4.0.123" />
```
```md
# @remotion/my-package<AvailableFrom v="4.0.123" />
```
For section headings:
```md
## Saving to another cloud<AvailableFrom v="3.2.23" />
```
### CompatibilityTable
Use to indicate which runtimes and environments a component or API supports. No import needed. Place it in a `## Compatibility` section before `## See also`.
Available boolean props: `chrome`, `firefox`, `safari`, `player`, `studio`, `clientSideRendering`, `serverSideRendering`. Set to `true` (supported) or `{false}` (not supported).
Set to empty string `""` for not applicable if this is a frontend API: `nodejs=""`, `bun=""`, `serverlessFunctions=""`.
Use `hideServers` to hide the Node.js/Bun/serverless row if this is a frontend API.
```md
## Compatibility
<CompatibilityTable chrome firefox safari nodejs="" bun="" serverlessFunctions="" clientSideRendering={false} serverSideRendering player studio hideServers />
```
### Optional parameters
For optional parameters in API documentation:
1. **Add `?` to the heading** - this indicates the parameter is optional
--> Don't do it if it is a CLI flag (beginning with `--`) - CLI flags are always optional
2. **Do NOT add `_optional_` text** - the `?` suffix is sufficient
3. **Include default value in description** - mention it naturally in the text
```md
### onError?
Called when an error occurs. Default: errors are thrown.
```
**Do NOT do this:**
```md
### onError?
_optional_
Called when an error occurs.
```
### Combining optional and AvailableFrom
When a parameter is both optional and was added in a specific version:
```md
### onError?<AvailableFrom v="4.0.50" />
Called when an error occurs.
```
### "Optional since" pattern
If a parameter became optional in a specific version (was previously required):
```md
### codec?
Optional since <AvailableFrom v="5.0.0" inline />. Previously required.
```
## Generating preview cards
After adding or editing a page, generate social media preview cards:
```bash
cd packages/docs && bun render-cards.ts
```
The command uploads cards to `https://remotion.media/docs/generated/` and
requires R2 credentials from the docs environment or `bun --env-file`.
Commit the hosted `image:` frontmatter; local generated PNGs are ignored.
To replace an existing card, pass `--overwrite=<composition-id>`.
## Streamlining existing docs
When asked to audit or streamline docs, scan for:
- Missing `<AvailableFrom>` indicators for APIs, features, options, parameters, or behaviors introduced in a specific version
- API names that are not formatted as code spans or linked to their docs page
- Function and hook references missing `()`
- API pages that should have a `## Compatibility` section with `<CompatibilityTable>`
- Fragile or broken `<Step>` formatting
Wersje
| Repozytorium | Wynik | Licencja |
|---|---|---|
| Ta strona · jamescai-md/motionframe-edit | 100 | MIT |
| smarzban/agent-skills | 100 | MIT |
| remotion-dev/remotion | 100 | MIT |
| nukeop/nuclear | 100 | AGPL-3.0 |
| foryourhealth111-pixel/Vibe-Skills | 100 | Apache-2.0 |
| it-bens/ai-tools | 100 | MIT |
| MoizIbnYousaf/marketing-cli | 100 | MIT |
| spgsroot/omp-agent-skills | 90 | MIT |
Migawka bazy z 13.11.2026 · wersja paczki 0465c96b7659 (skrót SHA-256 całej paczki)
Pobrania w ostatnich 30 dniach: 0 · ranking
Zgłoś problem z tym skillem: szkodliwa treść, błędny opis albo prośba autora o usunięcie.
Podobne skille
- 100technical-docs
Pisze i recenzuje dokumentację techniczną SDK Sentry, zwłaszcza pliki MDX w docs/platforms. - 100local-geistdocs-92c51f3a
Podpowiada, jak budować strony dokumentacji w Geistdocs na Next.js i Fumadocs: MDX, konfigurację, czat AI i wdrożenie. - 90write-docs
Pisze i przerabia dokumentację QUI Docs w plikach MDX: strony, nawigację, linki, przykłady i materiały graficzne przed pull requestem. - 100update-docs
Sprawdza, jaka dokumentacja Next.js wymaga zmian po modyfikacjach w PR, tworzy szkielety dokumentów dla nowych funkcji w plikach MDX i ocenia kompletność docs. - 100docs-write
Tworzy i edytuje dokumentację w stylu Metabase, który jest rozmowny, przejrzysty i ukierunkowany na użytkownika, w plikach markdown i MDX. - 95docs
Koordynuje publiczną dokumentację wtyczek i agentów na poziomie repozytorium, strony MDX i nawigacji, wraz z przeglądem.