Toolverse
Wszystkie skille

generate-component-documentation

autor: longbridge

Automatycznie generuj dokumentację dla nowych komponentów UI

Instalacja

Wybierz klienta i sklonuj repozytorium do odpowiedniego katalogu skilli.

Instalacja

Szybkie info

Kategoria
Frontend

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ć

  1. Upewnij się, że masz dostęp do repozytorium projektu zawierającego folder docs z przykładami dokumentacji (np. button.md, accordion.md) oraz folder crates/story/src/stories z implementacjami komponentów.

  2. Aktywuj skill w Claude lub Codex, wskazując komponent, dla którego chcesz wygenerować dokumentację — podaj jego nazwę i lokalizację w projekcie.

  3. Skill przeanalizuje istniejące wzorce dokumentacji w folderze docs i dostosuje styl do konwencji projektu.

  4. Skill odnajdzie implementację komponentu w crates/story/src/stories i na jej podstawie wygeneruje opis, listę props oraz przykłady użycia.

  5. Dla referencji API skill automatycznie wstawi linki do docs.rs w blokach kodu markdown, aby ułatwić dostęp do pełnej dokumentacji.

  6. Przejrzyj wygenerowaną dokumentację, dostosuj wizualizacje lub przykłady jeśli jest to konieczne, a następnie zapisz plik w folderze docs projektu.

Podobne skille