金色时刻 · 15:48
让好资源,触手可及
AGENT SKILL

adding-documentation-pages

adding-documentation-pages 是面向文档处理的 Agent Skill,来自 coollabsio/coolify-docs。查看技能说明、操作步骤与使用约定,并通过原项目了解详细用法。

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/.

SKILL.md

下载 MD ↓
nameadding-documentation-pages
descriptionCreates 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-toolsRead, 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

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

  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]

Related Skills

  • adding-service-documentation - For docs/services/ pages
  • renaming-services - Renaming service docs
  • disabling-services - Deprecating services

来源:coollabsio/coolify-docs · Apache-2.0 许可 · 许可原文 · MD 为来源页保存的历史版本