Toolverse
All skills

wiki-gen

by openclaw

Generate a project wiki from your codebase. Use when creating documentation.

Installation

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

Installation

Quick info

Author
openclaw
Category
Backend
Views
2

About this skill

Generate a project wiki from your codebase. Use when creating documentation.

How to use

  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.

Related skills