Toolverse
Wszystkie skille

adding-service-documentation

autor: coollabsio

Automatyzuj tworzenie dokumentacji nowych usług w Coolify z logotypami i katalogiem

Instalacja

Wybierz klienta i sklonuj repozytorium do odpowiedniego katalogu skilli.

Instalacja

Szybkie info

Kategoria
Backend
Wyświetlenia
4

O skillu

Skill do dokumentowania nowych usług w projekcie Coolify. Automatycznie tworzy strony markdown w katalogu docs/services/, pobiera logotypy usług do docs/public/images/services/ i aktualizuje komponent List.vue. Użyj go gdy dodajesz dokumentację dla nowej usługi, tworzysz strony serwisów lub rozszerzasz katalog usług o nowe wpisy z szablonów compose.

Jak używać

  1. Zidentyfikuj nową usługę z repozytorium Coolify, znajdując jej szablon YAML w katalogu templates/compose/ na GitHubie.

  2. Wyodrębnij metadane z nagłówka szablonu YAML usługi — będą potrzebne do dokumentacji.

  3. Pobierz logotyp usługi z repozytorium Coolify (katalog public/svgs/) i zapisz go w docs/public/images/services/ w dokumentacji.

  4. Utwórz plik dokumentacji markdown pod ścieżką docs/services/{slug-usługi}.md, zawierający opis, konfigurację i instrukcje użycia.

  5. Zaktualizuj komponent List.vue w docs/.vitepress/theme/components/Services/, aby nowa usługa pojawiła się w katalogu.

  6. Dodaj wpis o nowej usłudze do pliku docs/services/all.md, utrzymując kategoryzację i porządek alfabetyczny.

  7. Przetestuj zmiany lokalnie uruchamiając bun run dev i sprawdź, czy dokumentacja wyświetla się poprawnie.

Podobne skille