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
Author pages directly in content/docs/. source.config.ts selects this tree for Fumadocs. Read CLAUDE.md for repository conventions; do not use the removed VitePress tree or run the one-time generate:content migration script.
Workflow
- Choose the current section and a lowercase kebab-case
.mdxfilename. Inspect nearby pages before choosing a location. - Start from
templates/blank.mdx,templates/guide.mdx, ortemplates/troubleshooting.mdx, replacing placeholders. See TEMPLATES.md for examples. - Add a specific
titleand descriptivedescriptionin frontmatter. Write clear headings and verified instructions. - Add the extensionless page name to the containing folder's
meta.jsonwhen the page should appear in navigation. See SIDEBAR.md. - Save images in
public/images/{section}/and reference them as/docs/images/.... Use<ZoomImage>;<ZoomableImage>is a supported alias. - Check the page and navigation at
http://localhost:3000/docs/{path}. Use the relevant checks in TESTING.md.
Current Sections
| Content | Location |
|---|---|
| Getting started | Root pages such as content/docs/choose-your-path.mdx and content/docs/start-with-self-hosted.mdx |
| Platform and infrastructure | content/docs/core/ |
| Applications | content/docs/applications/ |
| Databases | content/docs/databases/ |
| Knowledge base | content/docs/knowledge-base/ |
| Troubleshooting | content/docs/troubleshoot/ |
| Integrations | content/docs/integrations/ |
| CLI and MCP guides | content/docs/cli/ and content/docs/mcp/ |
Individual one-click service pages use adding-service-documentation. The CLI command-reference pages and OpenAPI endpoints have separate generators; do not hand-edit generated reference output.
MDX Conventions
---
title: "Page Title"
description: "What the reader will learn or accomplish."
---
Use <Callout type="info" title="Note"> for callouts, with blank lines around Markdown children. VitePress ::: containers are unsupported. Escape literal JSX characters and braces in prose or put commands and configuration in code fences.
Internal links use extensionless paths without the /docs base, such as /core/infrastructure/servers/ssh-keys. Asset URLs retain the base: /docs/images/....
References
- FRONTMATTER.md: metadata read by the current application.
- IMAGES.md: asset locations, formats, and components.
- LINKS.md: routes, anchors, and external links.
- CONTAINERS.md: MDX callouts, tabs, and steps.
Before committing, check the chosen content path, the relevant meta.json, component syntax, image URLs, and the rendered page. For renamed paths, preserve redirects and run the redirect checker as described in CLAUDE.md.
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 | 6mo | No flags | Beginner |
| ml-paper-writing | 48 | 9mo | Review | Advanced |
| docs-review | 10 | 11mo | No flags | Beginner |
| claude-md-improver | 21 | 10mo | 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.