К основному содержанию
скилл CX Codex

adding-documentation-pages — скилл для Claude Code: создание страниц

Скилл adding-documentation-pages помогает создавать и обновлять MDX-гайды, статьи базы знаний и страницы устранения неполадок для Coolify. Он пригодится при работе с документацией в content/docs/.

Apache-2.0 1 установок ★ 395 обновлён 2026-10-29

Установить в Claude Code · Через Skills CLI (Vercel) Все способы и платформы ↓
npx skills add coollabsio/coolify-docs --skill adding-documentation-pages -a claude-code
Открыть на GitHub

Что делает adding-documentation-pages

Скилл ведёт по процессу создания страницы: выбрать раздел и имя файла в kebab-case, изучить соседние материалы, затем взять шаблон из templates/blank.mdx, templates/guide.mdx или templates/troubleshooting.mdx. Он напоминает добавить заголовок и описание, написать проверенные инструкции и при необходимости включить страницу в навигацию через meta.json.

В документации также описаны правила для изображений, ссылок и MDX-компонентов, а готовую страницу предлагают проверить по адресу http://localhost:3000/docs/{path}. Для работы нужно учитывать соглашения репозитория из CLAUDE.md; CLI-справочник и OpenAPI-страницы генерируются отдельно, поэтому вручную их не редактируют. Это ограничение важно, если задача касается справочной страницы команды или API.

Скилл предназначен для общих гайдов, руководств и статей базы знаний. Для отдельных страниц one-click-сервисов в репозитории предусмотрен другой скилл — adding-service-documentation.

Какие задачи решает

  • создать MDX-гайд в подходящем разделе content/docs/
  • добавить страницу в навигацию через meta.json
  • подготовить страницу с шаблоном для устранения неполадок
  • проверить ссылки и изображения в документации Coolify

Примеры запросов агенту

  • Создай гайд по настройке из раздела content/docs/integrations/ и добавь его в meta.json.
  • Подготовь страницу устранения неполадок для content/docs/troubleshoot/, используя подходящий шаблон.
  • Обнови MDX-страницу в content/docs/ и проверь её ссылки и компоненты.

Как установить adding-documentation-pages

1Через Skills CLI (Vercel)

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

2Вручную: положить файлы

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

Папка скилла целиком; для одного проекта — .claude/skills/adding-documentation-pages/

По шагам, с командами для каждой платформы: Как установить скилл в Claude Code: пять способов

Вопросы об adding-documentation-pages

Как установить adding-documentation-pages в Claude Code?

Выполните npx skills add coollabsio/coolify-docs --skill adding-documentation-pages -a claude-code. Файл скилла появится по пути ~/.claude/skills/adding-documentation-pages/SKILL.md.

Что делает скилл adding-documentation-pages?

Он помогает создавать и обновлять MDX-гайды, учебные материалы, статьи базы знаний и страницы устранения неполадок Coolify в content/docs/, включая настройку навигации.

Где добавлять страницу в навигацию Coolify?

Добавьте имя страницы без расширения в meta.json папки соответствующего раздела. Так страница появится в навигации.

Исходный текст

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

Похожие скиллы

Все скиллы по теме «Тексты и документация» →
adding-api-docs spencerpauly Скилл adding-api-docs собирает OpenAPI/Swagger-описание вашего API: схемы эндпоинтов, типы запросов и ответов, интерактивную страницу документации. CX Codex +1 455установок read-deleted-pages UseOSINT Скилл read-deleted-pages для Claude Code и ещё пяти платформ, который достаёт удалённые, изменённые или исторические версии страниц через Wayback Machine, CDX API, archive.today и Common Crawl. CX Codex +1 2 100установок alternatives-pages jonathimer Скилл alternatives-pages помогает составить честные страницы сравнения с конкурентами и гайды по миграции для инструментов разработки. CX Codex +1 ★ 88звёзд репо adding-dependencies riekelt Скилл adding-dependencies помогает решить, нужна ли проекту новая зависимость, как её проверить и обновлять. Пригодится перед добавлением пакета, SDK или GitHub Action. CX Codex +1 25 500установок documentation-and-adrs addyosmani Скилл documentation-and-adrs для Claude Code фиксирует архитектурные решения и помогает находить устаревшую документацию. Подключается при изменении публичного API, выпуске функций и проверке соответствия документов коду. CX Codex +1 80 700установок golang-documentation samber Скилл golang-documentation настраивает стандарты документации в Go-проектах: от godoc-комментариев и Example-тестов до README и llms.txt. Пригодится при оформлении библиотек и CLI перед релизом. CX Codex +1 42 700установок

Спонсоры проекта

Компании, которые помогают держать аналитику открытой