writing-docs
Asystent do pisania i edycji dokumentacji Remotion w formacie MDX
Instalacja
Wybierz klienta i sklonuj repozytorium do odpowiedniego katalogu skilli.
Instalacja
O skillu
Skill Claude'a zawierający wytyczne i best practices do tworzenia stron dokumentacji Remotion. Używaj go, gdy dodajesz nowe strony, edytujesz pliki MDX w katalogu packages/docs lub piszesz treści dokumentacyjne. Skill obejmuje reguły strukturyzacji API, formatowania nagłówków, linków do terminologii oraz wytyczne językowe — wszystko po to, aby dokumentacja była zwięzła, czytelna i skoncentrowana na użytkowniku.
Jak używać
Zainstaluj skill w swoim projekcie Remotion, umieszczając go w katalogu .claude/skills/writing-docs w repozytorium.
Gdy planujesz dodać nową stronę dokumentacji, utwórz plik .mdx w katalogu packages/docs/docs i zarejestruj go w pliku packages/docs/sidebars.ts.
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.
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').
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.
Po napisaniu dokumentacji uruchom polecenie bun render-cards.ts w katalogu packages/docs, aby wygenerować karty podglądu dla mediów społecznościowych.