Skip to main content

adding-documentation-pages

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

소스 정보

저장소
coollabsio/coolify-docs
최근 소스 활동
2026년 4월 27일 12:42
감지된 SKILL.md 언어
영어
스타
388
포크
347

설치 방법

기본적으로 소스를 먼저 확인하는 Prompt가 선택됩니다. 직접 명령으로 전환하거나 로컬 사본을 다운로드할 수도 있습니다.

소스 파일 검토

설치 여부를 결정하기 전에 SKILL.md와 SkillsMP에 표시된 보조 파일을 읽어 보세요.

파일 탐색기
3 개 파일

SKILL.md 표시 중

SKILL.md
소스 지침 · 읽기 전용 미리보기
name
adding-documentation-pages
description
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/.
allowed-tools
Read, 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 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 | 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 ```yaml --- 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](./TEMPLATES.md) - Ready-to-use page templates - [SIDEBAR.md](./SIDEBAR.md) - How to update sidebar configuration **Shared guidelines:** - [FRONTMATTER.md](../_shared/FRONTMATTER.md) - Title, description, Open Graph - [IMAGES.md](../_shared/IMAGES.md) - Image syntax and optimization - [LINKS.md](../_shared/LINKS.md) - Internal and external link formatting - [CONTAINERS.md](../_shared/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
GitHub에서 보기