packages-documentation

Skill do pisania i aktualizacji dokumentacji publicznych interfejsów API. Pomaga strukturyzować dokumenty referencyjne, przewodniki użytkownika, docstringi, przykłady kodu, przewodniki migracji i notyfikacje deprecacji. Obsługuje organizację dokumentów w folderach docs/ podzielonych po pakietach, z sekcjami na API reference, guides, concepts i getting-started. Automatyzuje formatowanie frontmatter, nazewnictwo plików zgodne z eksportowanymi funkcjami i klasami, oraz dokumentowanie parametrów, typów TypeScript i powiązanych API.

1. Zainstaluj skill w swoim edytorze obsługującym Cursor lub kompatybilnym narzędziu, wskazując repozytorium reactive/data-client i ścieżkę .cursor/skills/packages-documentation. 2. Zidentyfikuj pakiet, do którego należy kod, który dokumentujesz – sprawdź, czy to @data-client/core, @data-client/react, @data-client/rest czy @data-client/graphql. 3. Ustal, jaki typ dokumentu potrzebujesz: API reference (dla funkcji, hooków, klas), guide (poradnik jak-to-zrobić), concept (wyjaśnienie koncepcji) czy getting-started (wprowadzenie). 4. Utwórz plik w odpowiednim folderze (docs/{pakiet}/api/, docs/{pakiet}/guides/ itd.), nazwiąc go zgodnie z eksportowaną nazwą – np. useSuspense.md dla hooka useSuspense.ts. 5. Dodaj frontmatter z metadanymi (title, sidebar_label) i strukturyzuj zawartość: opis, przykłady kodu, dokumentacja parametrów, typy TypeScript, linki do powiązanych API. 6. Sprawdź, czy plik pasuje do struktury pakietu, i upewnij się, że wszystkie eksportowane symbole mają odpowiadające im pliki dokumentacji.