Toolverse
All skills

generate-component-documentation

by longbridge

Generate documentation for new components. Use when writing docs, documenting components, or creating component documentation.

Installation

Pick a client and clone the repository into its skills directory.

Installation

Quick info

Category
Frontend

About this skill

Generate documentation for new components. Use when writing docs, documenting components, or creating component documentation.

How to use

  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.

Related skills