generate-component-documentation
Automatycznie generuj dokumentację dla nowych komponentów UI
Instalacja
Wybierz klienta i sklonuj repozytorium do odpowiedniego katalogu skilli.
Instalacja
O skillu
Skill do szybkiego tworzenia dokumentacji komponentów. Generuje opisy, referencje API, przykłady użycia i wizualizacje na podstawie istniejących wzorców w projekcie. Idealny dla zespołów rozwijających biblioteki komponentów UI — oszczędza czas przy dokumentowaniu nowych elementów interfejsu.
Jak używać
Upewnij się, że masz dostęp do repozytorium projektu zawierającego folder
docsz przykładami dokumentacji (np.button.md,accordion.md) oraz foldercrates/story/src/storiesz implementacjami komponentów.Aktywuj skill w Claude lub Codex, wskazując komponent, dla którego chcesz wygenerować dokumentację — podaj jego nazwę i lokalizację w projekcie.
Skill przeanalizuje istniejące wzorce dokumentacji w folderze
docsi dostosuje styl do konwencji projektu.Skill odnajdzie implementację komponentu w
crates/story/src/storiesi na jej podstawie wygeneruje opis, listę props oraz przykłady użycia.Dla referencji API skill automatycznie wstawi linki do
docs.rsw blokach kodu markdown, aby ułatwić dostęp do pełnej dokumentacji.Przejrzyj wygenerowaną dokumentację, dostosuj wizualizacje lub przykłady jeśli jest to konieczne, a następnie zapisz plik w folderze
docsprojektu.