Back to list
coollabsio

adding-documentation-pages

by coollabsio

Documentation for Coolify

311🍴 244📅 Jan 23, 2026

SKILL.md


name: adding-documentation-pages description: Creates documentation pages for guides, tutorials, knowledge base articles, and troubleshooting content in docs/. Use when adding how-to guides, writing KB articles, creating troubleshooting docs, adding pages to get-started/, applications/, databases/, knowledge-base/, or integrations/. NOT for service pages - use adding-service-documentation for docs/services/. allowed-tools: Read, Grep, Glob, Write, Edit

Add Documentation Page

Create new documentation pages for the Coolify docs (guides, tutorials, KB articles, troubleshooting).

When NOT to Use This Skill

Use adding-service-documentation instead for:

  • Service pages in docs/services/
  • One-click services from Coolify's catalog

Services require List.vue registration and logo handling covered by that skill.

Quick Start

  1. Create file in the appropriate section directory
  2. Add frontmatter with title and description
  3. Write content with clear headings
  4. Update sidebar in docs/.vitepress/config.mts (if needed)
  5. Add images using <ZoomableImage> component

Documentation Sections

SectionPathContent Type
Get Starteddocs/get-started/Introduction, installation, basics
Applicationsdocs/applications/Framework deployment guides
Databasesdocs/databases/Database deployment docs
Knowledge Basedocs/knowledge-base/How-tos, concepts, guides
Troubleshootdocs/troubleshoot/Problem-solution articles
Integrationsdocs/integrations/Third-party integration guides

Required Frontmatter

---
title: "Page Title"
description: "SEO-friendly description (used in meta tags)."
---

File Naming

  • Use lowercase kebab-case: my-guide.md
  • Be descriptive but concise

Detailed References

Page-specific:

Shared guidelines:

Key Rules

  1. Images:
    • Small images/icons: use standard markdown ![alt](path)
    • Screenshots/large images: use <ZoomableImage> component
    • Format: .webp preferred, absolute paths (/docs/images/...)
  2. Links: Internal use absolute paths; external add ?utm_source=coolify.io
  3. Sidebar: Update docs/.vitepress/config.mts (starts ~line 130)

Verification

  • Frontmatter has title and description
  • Screenshots use <ZoomableImage>
  • External links have UTM parameters
  • Page added to sidebar (if applicable)
  • Renders at http://localhost:5173/docs/[path]
  • adding-service-documentation - For docs/services/ pages
  • renaming-services - Renaming service docs
  • disabling-services - Deprecating services

Score

Total Score

75/100

Based on repository quality metrics

SKILL.md

SKILL.mdファイルが含まれている

+20
LICENSE

ライセンスが設定されている

+10
説明文

100文字以上の説明がある

0/10
人気

GitHub Stars 100以上

+5
最近の活動

1ヶ月以内に更新

+10
フォーク

10回以上フォークされている

+5
Issue管理

オープンIssueが50未満

+5
言語

プログラミング言語が設定されている

+5
タグ

1つ以上のタグが設定されている

+5

Reviews

💬

Reviews coming soon