W
wiki-gen
Generate a project wiki from your codebase. Use when creating documentation.
Installation
Pick a client and clone the repository into its skills directory.
Installation
About this skill
Generate a project wiki from your codebase. Use when creating documentation.
How to use
- Upewnij się, że masz zainstalowany Node.js 18 lub nowszą wersję oraz ustawioną zmienną środowiskową OPENAI_API_KEY z Twoim kluczem API OpenAI.
- Przejdź do katalogu Twojego projektu w terminalu.
- Uruchom komendę npx ai-wiki ./src/, zastępując ./src/ ścieżką do folderu, który chcesz zdokumentować (np. ./lib/ dla bibliotek).
- Czekaj, aż narzędzie przeskanuje kod i wygeneruje strony wiki w formacie markdown dla każdego modułu i komponentu.
- Przejrzyj wygenerowaną dokumentację, dodaj ręcznie brakujące kontekst i niuanse, które AI mogło przeoczyć.
- Regularnie regeneruj wiki po zmianach w kodzie, aby dokumentacja pozostała aktualna — uruchom tę samą komendę ponownie.