P
packages-documentation
Write, update, and format docs for public APIs - API reference, README, docstrings, usage examples, migration guides, deprecation notices
Installation
Pick a client and clone the repository into its skills directory.
Installation
About this skill
Write, update, and format docs for public APIs - API reference, README, docstrings, usage examples, migration guides, deprecation notices
How to use
- Zainstaluj skill w swoim edytorze obsługującym Cursor lub kompatybilnym narzędziu, wskazując repozytorium
reactive/data-clienti ś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/restczy@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.mddla hookauseSuspense.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.