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
- Create file in the appropriate section directory
- Add frontmatter with
title and description
- Write content with clear headings
- Update sidebar in
docs/.vitepress/config.mts (if needed)
- Add images using
<ZoomableImage> component
Documentation Sections
| Section |
Path |
Content Type |
| Get Started |
docs/get-started/ |
Introduction, installation, basics |
| Applications |
docs/applications/ |
Framework deployment guides |
| Databases |
docs/databases/ |
Database deployment docs |
| Knowledge Base |
docs/knowledge-base/ |
How-tos, concepts, guides |
| Troubleshoot |
docs/troubleshoot/ |
Problem-solution articles |
| Integrations |
docs/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
- Images:
- Small images/icons: use standard markdown

- Screenshots/large images: use
<ZoomableImage> component
- Format:
.webp preferred, absolute paths (/docs/images/...)
- Links: Internal use absolute paths; external add
?utm_source=coolify.io
- Sidebar: Update
docs/.vitepress/config.mts (starts ~line 130)
Verification
Related Skills
adding-service-documentation - For docs/services/ pages
renaming-services - Renaming service docs
disabling-services - Deprecating services