doc-check

Skill analizuje różnice w kodzie i określa, czy dokumentacja powinna być zaktualizowana lub uzupełniona. Sprawdza zgodność dokumentacji z kodem, brakujące opisy nowych funkcji, zmian API, flag CLI i konfiguracji. Przydatny dla zespołów chcących utrzymać dokumentację na bieżąco z rozwojem projektu. Integruje się z pull requestami i lokalnymi zmianami.

1. Przygotuj różnicę kodu — dla pull requesta użyj gh pr diff <NUMER_PR> --repo coder/coder, dla zmian lokalnych uruchom git diff main lub git diff --staged, dla gałęzi użyj git diff main...<GAŁĄŹ>.

2. Uruchom skill, przekazując różnicę kodu — możesz dostarczyć metodę pobierania zmian w promptie lub pozwolić skillowi na automatyczne pobranie różnicy.

3. Skill analizuje zakres zmian — ocenia, czy zmiany dotyczą funkcjonalności widocznej dla użytkownika czy wewnętrznych komponentów, oraz czy wpływają na zachowanie, API, flagi CLI lub konfigurację.

4. Skill przeszukuje dokumentację — sprawdza folder docs/ w poszukiwaniu powiązanej treści i weryfikuje jej aktualność.

5. Skill raportuje wyniki — wskazuje, czy istniejąca dokumentacja wymaga aktualizacji, czy potrzebna jest nowa dokumentacja, czy wszystko jest już udokumentowane, oraz sprawdza poprawność przykładów i zmian w API.

6. Przejrzyj rekomendacje — jeśli dokumentacja wymaga zmian, zaktualizuj odpowiednie pliki w docs/ i upewnij się, że nowe strony są dodane do docs/manifest.json.