adding-service-documentation

Extract YAML metadata from Coolify templates and generate service documentation.

369|323|Updated Sep 4, 2024
One-click install
npx skills add https://github.com/coollabsio/coolify-docs --skill adding-service-documentation
Or copy as Structured Prompt for Agent
Please help me install this Agent Skill.
Skill: adding-service-documentation
Source: https://github.com/coollabsio/coolify-docs/tree/main/.claude/skills/adding-service-documentation
Command: npx skills add https://github.com/coollabsio/coolify-docs --skill adding-service-documentation

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve?

This skill streamlines creating and documenting new services for Coolify by guiding you through extracting metadata, saving logos, drafting docs, and updating the catalog.

Core Features & Use Cases

  • Automates metadata extraction from YAML templates in templates/compose.
  • Downloads and stores service logos to docs/public/images/services/.
  • Generates documentation pages at docs/services/{slug}.md and updates List.vue.
  • Useful for onboarding new services from templates/compose or updating the services catalog.

Quick Start

Use the adding-service-documentation skill to document a new service by following the steps: identify the service from templates/compose, extract metadata, download the logo to docs/public/images/services/, create docs/services/{slug}.md, and update List.vue.

Frequently Asked Questions about adding-service-documentation

High-intent search queries and answers about installing and using this skill.

FAQPage Schema
How do I document a new Coolify service from a compose template?

To document a Coolify service, extract YAML metadata from templates/compose, download the logo to docs/public/images/services/, create docs/services/{slug}.md, and update List.vue. This ensures file paths and frontmatter conventions are followed for UI consistency.

How do I add a new service to the Coolify catalog UI?

Adding a service to the Coolify catalog requires updating List.vue with the new entry. The workflow involves extracting metadata from the compose template, saving the logo, generating the markdown documentation, and appending the service to the Vue catalog file.

What is the file path convention for Coolify service logos and docs?

Coolify service logos must be saved to docs/public/images/services/, while documentation pages follow the docs/services/{slug}.md path. Adhering to these specific directories ensures the documentation renders correctly in the UI.

Can I automate metadata extraction for Coolify compose templates?

Yes, service documentation can be automated by extracting YAML metadata directly from templates/compose. This metadata populates the generated markdown files and updates the List.vue catalog, streamlining both onboarding and maintenance.

Do I need to manually update List.vue when onboarding a new Coolify service?

Manual List.vue updates are avoided by automating the catalog maintenance. The documentation workflow extracts the service metadata, creates the markdown page, and programmatically updates the Vue catalog to maintain UI consistency.