Toolverse
Wszystkie skille

material-component-doc

autor: bytedance

Automatyzuj tworzenie dokumentacji komponentów i Story'ów dla biblioteki FlowGram

Instalacja

Wybierz klienta i sklonuj repozytorium do odpowiedniego katalogu skilli.

Instalacja

Szybkie info

Kategoria
Frontend

O skillu

Skill do generowania dokumentacji komponentów w FlowGram. Automatyzuje tworzenie Story'ów, dokumentacji w formacie MDX oraz tłumaczenia między chińskim a angielskim. Przeprowadzi Cię przez analizę kodu źródłowego, zbieranie wymagań od użytkownika, pisanie dokumentacji na podstawie szablonu oraz kontrolę jakości. Obsługuje zarówno dokumentację chińską jak i angielską z podziałem na katalogi.

Jak używać

  1. Zlokalizuj kod źródłowy komponentu w katalogu packages/materials/form-materials/src/components, używając narzędzia Glob do wyszukania pliku i potwierdzenia struktury katalogów (hooks.ts, context.tsx itp.).
  2. Zbierz informacje o komponencie od użytkownika: główne scenariusze użycia, 1-2 przykłady kodu, specjalne konfiguracje i czy potrzebne są ilustracje.
  3. Przeanalizuj kod źródłowy, aby zrozumieć interfejsy Props (typy, wartości domyślne, opisy), funkcjonalność, zależności od API FlowGram, Hooks i Context, oraz specjalną logikę (warunkowe renderowanie, efekty uboczne).
  4. Utwórz komponent Story w katalogu apps/docs/components/form-materials/components zgodnie z konwencją kebab-case dla nazwy pliku i PascalCase + "Story" dla eksportów (np. BasicStory, WithSchemaStory).
  5. Napisz dokumentację w formacie MDX na podstawie szablonu ./templates/material.mdx i umieść ją w apps/docs/src/zh/materials/components/{nazwa-komponentu}.mdx dla wersji chińskiej.
  6. Przeprowadź kontrolę jakości: sprawdź czy Story działa, kody są dokładne, tabela API kompletna, linki działają, ścieżki obrazów prawidłowe, składnia Mermaid poprawna. Po zatwierdzeniu dokumentacji chińskiej przystąp do tłumaczenia na angielski do katalogu apps/docs/src/en/materials/components/.

Podobne skille