Awesome-omni-skill adding-service-documentation

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.

install

source · Clone the upstream repo

git clone https://github.com/diegosouzapw/awesome-omni-skill

Claude Code · Install into ~/.claude/skills/

T=$(mktemp -d) && git clone --depth=1 https://github.com/diegosouzapw/awesome-omni-skill "$T" && mkdir -p ~/.claude/skills && cp -r "$T/skills/documentation/adding-service-documentation" ~/.claude/skills/diegosouzapw-awesome-omni-skill-adding-service-documentation && rm -rf "$T"

manifest: skills/documentation/adding-service-documentation/SKILL.md

source content

Add Service Documentation

This skill guides you through documenting a new service in the Coolify documentation repository.

When to Use This Skill

Adding documentation for a new service from the Coolify repository
Creating service pages with proper formatting and images
Updating the services list component
Following documentation standards for service pages

Quick Start Workflow

Identify the service from Coolify's GitHub repository (
```
templates/compose/
```
)
Extract metadata from the YAML template header
Download the logo from GitHub and save to
```
docs/public/images/services/
```
Create documentation at
```
docs/services/{service-slug}.md
```

Update services list in

docs/.vitepress/theme/components/Services/List.vue

Update all services directory in
```
docs/services/all.md
```
Test locally with
```
bun run dev
```

File Structure

Coolify Repository (GitHub):
├── templates/compose/
│   └── service-name.yaml        # Service template with metadata
└── public/svgs/
    └── service-logo.svg          # Service logo

https://github.com/coollabsio/coolify/tree/main/templates/compose
https://github.com/coollabsio/coolify/tree/main/public/svgs

Documentation Repository:
├── docs/
│   ├── services/
│   │   ├── service-name.md       # Service documentation page
│   │   └── all.md                # All services directory (categorized list)
│   ├── public/images/services/
│   │   └── service-logo.svg      # Copied logo
│   └── .vitepress/theme/components/Services/
│       └── List.vue               # Services catalog (line ~261)

Required Files

Every service requires these 4 updates:

Service documentation (
```
docs/services/{slug}.md
```
)

Service logo (

docs/public/images/services/{name}-logo.{ext}

)

List entry (in

docs/.vitepress/theme/components/Services/List.vue

)

All services directory (
```
docs/services/all.md
```
) — add entry alphabetically under the correct category

Detailed Instructions

Service-specific:

METADATA.md - Extracting service info from YAML
DOCUMENTATION.md - Writing service docs
IMAGES.md - Service logo guidelines
CATALOG.md - Updating the services list
TEMPLATES.md - Documentation templates

Shared guidelines:

FRONTMATTER.md - Title, description, Open Graph
IMAGES.md - General image syntax
LINKS.md - Internal and external link formatting
CONTAINERS.md - VitePress callout containers

Important Rules

Download logos locally: NEVER use external image URLs - always download to
```
docs/public/images/services/
```
Skip ignored services: If YAML has
```
# ignore: true
```
, don't document it
Images: Use
```
![alt](path)
```
for logos; use
```
<ZoomableImage>
```
only for screenshots
Add UTM parameters: Append
```
?utm_source=coolify.io
```
to all external links
Follow naming: Use lowercase, hyphenated slugs (e.g.,
```
my-service.md
```
)
Alphabetical order: Insert services alphabetically in List.vue

Testing

# Start dev server
bun run dev

# Verify:
# - Service appears in list at http://localhost:5173/docs/services/
# - Logo displays correctly
# - Service page loads at /docs/services/{slug}
# - All links work
# - Category filter includes service

# Build for production
bun run build

Troubleshooting

Image not showing:

Check path starts with
```
/docs/images/services/
```
(not
```
/public/
```
)
Verify file exists in
```
docs/public/images/services/
```
Confirm file extension matches

Service not in list:

Verify entry added to
```
services
```
array in List.vue
Check
```
ignore: true
```
is not set
Ensure valid JavaScript syntax

Category missing:

Check category name matches existing categories (case-sensitive)
See CATALOG.md for full category list

Related Commands

```
/new-services
```
- Automated service documentation generator
Check existing services for examples in
```
docs/services/
```