Toolverse
All skills

adding-service-documentation

by coollabsio

Documents new Coolify one-click services by creating markdown pages in docs/services/, downloading logos to docs/public/images/services/, and updating List.vue catalog. Use when adding service documentation, creating service pages, onboarding services from templates/compose/, or

Installation

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

Installation

Quick info

Category
Backend
Views
4

About this skill

Documents new Coolify one-click services by creating markdown pages in docs/services/, downloading logos to docs/public/images/services/, and updating List.vue catalog. Use when adding service documentation, creating service pages, onboarding services from templates/compose/, or updating the services catalog with new entries.

How to use

  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.

Related skills