adding-documentation-pages

支持为 Coolify 文档体系新增各类技术文档页面,涵盖入门指南、应用部署、数据库配置、知识库文章、故障排查及第三方集成等内容,需遵循统一的前端配置规范、文件命名规则与内容组织标准。

快捷安装

在终端运行此命令,即可一键安装该 Skill 到您的 Claude 中

npx skills add coollabsio/coolify-docs --skill "adding-documentation-pages"

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 use a frontmatter-driven generation pipeline (the listing and all.md are regenerated from each service page’s frontmatter) and have specific 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