Skip to main content
skill CX Codex

adding-documentation-pages — Claude Code skill: create docs

The adding-documentation-pages skill guides agents through creating and updating Coolify MDX guides, knowledge-base articles, and troubleshooting pages in content/docs/.

Apache-2.0 1 installs ★ 395 updated 2026-10-29

Install into Claude Code · Skills CLI (Vercel) All methods and platforms ↓
npx skills add coollabsio/coolify-docs --skill adding-documentation-pages -a claude-code
Open on GitHub

What adding-documentation-pages does

The skill lays out a page-writing workflow: inspect nearby docs, choose a section and a lowercase kebab-case filename, then start from templates/blank.mdx, templates/guide.mdx, or templates/troubleshooting.mdx. It also covers page metadata and adding the extensionless filename to the section’s meta.json when it belongs in navigation.

Image placement, MDX components, and internal link formats are part of the guidance. It directs you to check the rendered page at http://localhost:3000/docs/{path} and follow repository conventions in CLAUDE.md. CLI reference pages and OpenAPI endpoints have separate generators, so this skill is not for editing their generated output.

Use adding-service-documentation for individual one-click service pages. That distinction matters when a documentation task is about a service entry rather than a guide or knowledge-base article.

What it helps with

  • draft an MDX guide in the right content/docs/ section
  • add a page to section navigation through meta.json
  • start a troubleshooting article from its template
  • check image paths and links on a Coolify docs page

Example prompts for the agent

  • Create a guide in content/docs/integrations/ and add its page name to meta.json.
  • Draft a troubleshooting page in content/docs/troubleshoot/ using the suitable template.
  • Update this MDX page in content/docs/ and check its links and components.

How to install adding-documentation-pages

1Skills CLI (Vercel)

npx skills add coollabsio/coolify-docs --skill adding-documentation-pages -a claude-code

2Manually: put the files in place

~/.claude/skills/adding-documentation-pages/SKILL.md

Copy the whole skill folder; for one project use .claude/skills/adding-documentation-pages/

Step by step, with commands for each platform: How to install skills in Claude Code: five ways

Questions about adding-documentation-pages

How do I install adding-documentation-pages in Claude Code?

Run npx skills add coollabsio/coolify-docs --skill adding-documentation-pages -a claude-code. The skill file is placed at ~/.claude/skills/adding-documentation-pages/SKILL.md.

What does adding-documentation-pages do?

It guides agents through writing and updating Coolify MDX guides, tutorials, knowledge-base articles, and troubleshooting pages under content/docs/, including navigation metadata.

How do I add a documentation page to the navigation?

Put the page filename without its extension in the meta.json file for its containing section. The page can then appear in that section’s navigation.

Source text

SKILL.md · Apache-2.0
---
name: adding-documentation-pages
description: Create or update Coolify MDX guides, tutorials, knowledge-base articles, and troubleshooting pages in content/docs/, with section meta.json navigation. Use adding-service-documentation for individual one-click service pages.
allowed-tools: Read, Grep, Glob, Write, Edit
---

# 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

1. Choose the current section and a lowercase kebab-case `.mdx` filename. Inspect nearby pages before choosing a location.
2. Start from `templates/blank.mdx`, `templates/guide.mdx`, or `templates/troubleshooting.mdx`, replacing placeholders. See [TEMPLATES.md](./TEMPLATES.md) for examples.
3. Add a specific `title` and descriptive `description` in frontmatter. Write clear headings and verified instructions.
4. Add the extensionless page name to the containing folder's `meta.json` when the page should appear in navigation. See [SIDEBAR.md](./SIDEBAR.md).
5. Save images in `public/images/{section}/` and reference them as `/docs/images/...`. Use `<ZoomImage>`; `<ZoomableImage>` is a supported alias.
6. Check the page and navigation at `http://localhost:3000/docs/{path}`. Use the relevant checks in [TESTING.md](../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](../adding-service-documentation/SKILL.md). The CLI command-reference pages and OpenAPI endpoints have separate generators; do not hand-edit generated reference output.

## MDX Conventions

```yaml
---
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](../_shared/FRONTMATTER.md): metadata read by the current application.
- [IMAGES.md](../_shared/IMAGES.md): asset locations, formats, and components.
- [LINKS.md](../_shared/LINKS.md): routes, anchors, and external links.
- [CONTAINERS.md](../_shared/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`.

© coollabsio · Apache-2.0 · coollabsio/coolify-docs

Similar skills

All skills for Writing and docs →

Project sponsors

Companies that keep this analytics open