adding-documentation-pages

Add Documentation Page

Safety Notice

This listing is imported from skills.sh public index metadata. Review upstream SKILL.md and repository scripts before running.

Copy this and send it to your AI assistant to learn

Install skill "adding-documentation-pages" with this command: npx skills add coollabsio/coolify-docs/coollabsio-coolify-docs-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 require List.vue registration and 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:

  • 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 alt

  • 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

  • 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]

Related Skills

  • adding-service-documentation

  • For docs/services/ pages

  • renaming-services

  • Renaming service docs

  • disabling-services

  • Deprecating services

Source Transparency

This detail page is rendered from real SKILL.md content. Trust labels are metadata-based hints, not a safety guarantee.

Related Skills

Related by shared tags or category signals.

General

pest-testing

No summary provided by upstream source.

Repository SourceNeeds Review
General

debugging-output-and-previewing-html-using-ray

No summary provided by upstream source.

Repository SourceNeeds Review
Coding

tailwindcss-development

No summary provided by upstream source.

Repository SourceNeeds Review