adding-documentation-pages
Scaffolds new documentation pages with frontmatter and VitePress navigation for Coolify.
Install
mkdir -p .claude/skills/adding-documentation-pages && curl -L -o skill.zip "https://agentskills.codes/api/skills/download/5104" && unzip -o skill.zip -d .claude/skills/adding-documentation-pages && rm skill.zipInstalls to .claude/skills/adding-documentation-pages
Activation
This is the description your AI agent reads to decide when to run this skill — the better it matches your request, the more reliably it fires.
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/.Key capabilities
- →Create documentation pages
- →Enforce frontmatter requirements
- →Update sidebar configuration
- →Add images using ZoomableImage
How it works
The skill provides a structured process for creating documentation files, ensuring correct frontmatter, image handling, and sidebar integration.
Inputs & outputs
When to use adding-documentation-pages
- →Write new how-to guides
- →Add troubleshooting articles
- →Create knowledge base pages
About this skill
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
When not to use it
- →Adding service pages in docs/services/
Limitations
- →Not for service-specific documentation
- →Requires manual sidebar updates
How it compares
It enforces specific frontmatter and component usage compared to standard markdown creation.
Compared to similar skills
adding-documentation-pages side by side with the closest alternatives in the catalog.
| Skill | Installs | Updated | Safety | Difficulty |
|---|---|---|---|---|
| adding-documentation-pages (this skill) | 1 | 3mo | No flags | Beginner |
| ml-paper-writing | 48 | 6mo | Review | Advanced |
| docs-review | 10 | 7mo | No flags | Beginner |
| claude-md-improver | 21 | 6mo | Review | Beginner |
Try saying
Example prompts that trigger this skill in your AI assistant.
More by coollabsio
View all by coollabsio →You might also like
ml-paper-writing
davila7
Write publication-ready ML/AI papers for NeurIPS, ICML, ICLR, ACL, AAAI, COLM. Use when drafting papers from research repos, structuring arguments, verifying citations, or preparing camera-ready submissions. Includes LaTeX templates, reviewer guidelines, and citation verification workflows.
docs-review
metabase
Review documentation changes for compliance with the Metabase writing style guide. Use when reviewing pull requests, files, or diffs containing documentation markdown files.
claude-md-improver
anthropics
Audit and improve CLAUDE.md files in repositories. Use when user asks to check, audit, update, improve, or fix CLAUDE.md files. Scans for all CLAUDE.md files, evaluates quality against templates, outputs quality report, then makes targeted updates. Also use when the user mentions "CLAUDE.md maintenance" or "project memory optimization".
write-docs
tldraw
Writing SDK documentation for tldraw. Use when creating new documentation articles, updating existing docs, or when documentation writing guidance is needed. Applies to docs in apps/docs/content/.
update-docs
vercel
This skill should be used when the user asks to "update documentation for my changes", "check docs for this PR", "what docs need updating", "sync docs with code", "scaffold docs for this feature", "document this feature", "review docs completeness", "add docs for this change", "what documentation is affected", "docs impact", or mentions "docs/", "docs/01-app", "docs/02-pages", "MDX", "documentation update", "API reference", ".mdx files". Provides guided workflow for updating Next.js documentation based on code changes.
wiki-architect
microsoft
Analyzes code repositories and generates hierarchical documentation structures with onboarding guides. Use when the user wants to create a wiki, generate documentation, map a codebase structure, or understand a project's architecture at a high level.