Toolverse
Wszystkie skille

update-docs

autor: vercel

Automatycznie aktualizuj dokumentację Next.js zgodnie ze zmianami w kodzie

Instalacja

Wybierz klienta i sklonuj repozytorium do odpowiedniego katalogu skilli.

Instalacja

Szybkie info

Autor
vercel
Kategoria
Backend
Wyświetlenia
38

O skillu

Skill do zarządzania dokumentacją Next.js podczas przeglądania pull requestów. Przeprowadzi Cię przez proces identyfikacji zmian w kodzie, mapowania ich na odpowiednie pliki dokumentacji i weryfikacji kompletności opisów. Narzędzie analizuje różnice między gałęziami, wskazuje, które fragmenty dokumentacji wymagają aktualizacji, i wspomaga Cię w procesie zatwierdzania zmian. Idealne dla maintainerów dbających o spójność kodu i dokumentacji.

Jak używać

  1. Uruchom analizę zmian poleceniem git diff canary...HEAD --stat, aby zobaczyć wszystkie pliki, które uległy modyfikacji na bieżącej gałęzi. Skill przeanalizuje wynik i wskaże, które zmiany mogą wpłynąć na dokumentację.
  2. Przejrzyj mapowanie zmian na pliki dokumentacji. Skill automatycznie powiąże modyfikacje w kodzie (np. w packages/next/src/client/components/) z odpowiadającymi im plikami dokumentacji w katalogach docs/01-app czy docs/02-pages.
  3. Przejdź przez każdy plik dokumentacji, który wymaga aktualizacji. Skill będzie prosić Cię o potwierdzenie każdej zmiany i przeprowadzać Cię krok po kroku przez proces edycji plików MDX.
  4. Zweryfikuj formatowanie dokumentacji poleceniem pnpm lint, aby upewnić się, że wszystkie pliki spełniają standardy projektu.
  5. Zatwierdź i wyślij zmiany dokumentacji. Skill pomoże Ci przygotować commita ze wszystkimi zaktualizowanymi plikami dokumentacji.

Podobne skille