Adding Documentation Pages
Documentsadding-documentation-pagesAdding Documentation Pages is an Agent Skill for documents published in the coollabsio/coolify-docs repository on GitHub: a SKILL.md instruction file an AI agent can load to do this task.
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/.
How to use this skill
Bring this guide into your coding agent with a prompt tailored to the tool you use.
- Open your project in Codex.
- Copy and paste the prompt below.
- Review files and risks before approving any action.
Inspect the Agent Skill at https://github.com/coollabsio/coolify-docs/blob/HEAD/.claude/skills/adding-documentation-pages/SKILL.md and all supporting files. Report provenance, permissions, scripts, dependencies, and security risks. Propose an exact installation into .agents/skills/adding-documentation-pages, but wait for my approval before writing files or running scripts.
Copying this prompt does not install or run the skill. Review third-party files before use.
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
titleanddescription - 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:
- TEMPLATES.md - Ready-to-use page templates
- SIDEBAR.md - How to update sidebar configuration
Shared guidelines:
- FRONTMATTER.md - Title, description, Open Graph
- IMAGES.md - Image syntax and optimization
- LINKS.md - Internal and external link formatting
- CONTAINERS.md - VitePress callout containers
Key Rules
- Images:
- Small images/icons: use standard markdown
 - Screenshots/large images: use
<ZoomableImage>component - Format:
.webppreferred, absolute paths (/docs/images/...)
- Small images/icons: use standard markdown
- Links: Internal use absolute paths; external add
?utm_source=coolify.io - Sidebar: Update
docs/.vitepress/config.mts(starts ~line 130)
Verification
- Frontmatter has
titleanddescription - Screenshots use
<ZoomableImage> - External links have UTM parameters
- Page added to sidebar (if applicable)
- Renders at http://localhost:5173/docs/[path]
Related Skills
adding-service-documentation- Fordocs/services/pagesrenaming-services- Renaming service docsdisabling-services- Deprecating services