wiki-gen

Wiki Generator skanuje Twoją bazę kodu i tworzy kompletną dokumentację projektu w formacie markdown. Narzędzie automatycznie generuje strony wiki dla każdego modułu, dokumentuje architekturę i tworzy strukturę nawigacji. Idealne do onboardingu nowych programistów, projektów open source i wewnętrznej dokumentacji. Wymaga tylko Node.js 18+ i klucza OpenAI API — uruchamiasz jedną komendę i gotowe.

1. Upewnij się, że masz zainstalowany Node.js 18 lub nowszą wersję oraz ustawioną zmienną środowiskową OPENAI_API_KEY z Twoim kluczem API OpenAI.
2. Przejdź do katalogu Twojego projektu w terminalu.
3. Uruchom komendę npx ai-wiki ./src/, zastępując ./src/ ścieżką do folderu, który chcesz zdokumentować (np. ./lib/ dla bibliotek).
4. Czekaj, aż narzędzie przeskanuje kod i wygeneruje strony wiki w formacie markdown dla każdego modułu i komponentu.
5. Przejrzyj wygenerowaną dokumentację, dodaj ręcznie brakujące kontekst i niuanse, które AI mogło przeoczyć.
6. Regularnie regeneruj wiki po zmianach w kodzie, aby dokumentacja pozostała aktualna — uruchom tę samą komendę ponownie.