write-docs

Skill do tworzenia i edycji artykułów dokumentacji SDK tldraw. Pomaga w pisaniu nowych artykułów, aktualizacji istniejących dokumentów oraz udzielaniu wskazówek dotyczących struktury i stylu dokumentacji. Obejmuje wszystkie pliki w katalogu apps/docs/content/, w tym przewodniki dla początkujących, dokumentację API, przykłady i notatki o wydaniach. Skill prowadzi Cię przez proces od zrozumienia grupy docelowej, przez tworzenie pliku MDX z odpowiednim frontmatter, aż do napisania treści zgodnie z ustaloną strukturą: przegląd, podstawowe użycie, szczegóły, przypadki brzegowe i linki.

1. Zidentyfikuj grupę docelową dla dokumentacji (nowi użytkownicy, doświadczeni deweloperzy, referencja API) i sprawdź istniejące artykuły na podobne tematy, aby uniknąć duplikacji.
2. Zapoznaj się z odpowiednim kodem źródłowym i przykładami w katalogu apps/examples/, aby zrozumieć funkcjonalność, którą dokumentujesz.
3. Utwórz nowy plik .mdx w odpowiednim katalogu (docs/, getting-started/, examples/ lub releases/) z frontmatter zawierającym tytuł, status, autora, datę, kolejność i słowa kluczowe.
4. Napisz zawartość zgodnie ze strukturą: najpierw przegląd (1-2 akapity co i dlaczego), następnie podstawowe użycie (najprostszy działający przykład), szczegóły z dodatkowymi przykładami, przypadki brzegowe i zaawansowane wzorce.
5. Używaj komponentów MDX do odwołań API (np. ClassName lub ClassName#methodName) i wyróżniania linii kodu za pomocą FocusLines.
6. Dodaj na końcu linki do powiązanej dokumentacji i przykładów, aby ułatwić nawigację użytkownikom.