writing-docs

Guides for writing and editing Remotion documentation. Use when adding docs pages, editing MDX files in packages/docs, or writing documentation content.

1. Zainstaluj skill w swoim projekcie Remotion, umieszczając go w katalogu .claude/skills/writing-docs w repozytorium.

2. Gdy planujesz dodać nową stronę dokumentacji, utwórz plik .mdx w katalogu packages/docs/docs i zarejestruj go w pliku packages/docs/sidebars.ts.

3. Napisz zawartość dokumentacji, pamiętając o kluczowych zasadach: każda funkcja lub API powinna mieć własną dedykowaną stronę, nie łącz wielu API na jednej stronie.

4. Strukturyzuj dokumentację, używając nagłówków (### dla właściwości głównych, #### dla zagnieżdżonych) zamiast list punktowanych, i dodaj frontmatter z polem crumb jeśli strona dotyczy konkretnego pakietu (np. crumb: '@remotion/my-package').

5. Stosuj wytyczne językowe: pisz zwięźle bez zbędnych słów, adresuj czytelnika jako "ty", unikaj emocjonalnych zwrotów, rozdzielaj tekst na akapity i linkuj do strony terminologii dla pojęć specyficznych dla Remotion.

6. Po napisaniu dokumentacji uruchom polecenie bun render-cards.ts w katalogu packages/docs, aby wygenerować karty podglądu dla mediów społecznościowych.