# rsyslog_doc

Скилл rsyslog_doc для Claude Code приводит страницы rsyslog в .rst к общему виду: оформляет метаданные, summary-блоки и сведения о модулях. Включается при работе с файлами doc/source/**/*.rst.

- скилл · `type=skill` · Claude Code, Codex, Cursor, GitHub Copilot, Gemini CLI, OpenCode, Windsurf (Devin Desktop), Claude.ai · 1 установка · ★ 2348 у репозитория
- Автор: rsyslog
- Лицензия: LGPL-3.0 · policy=link-only · показываем только описание, файл — у автора
- Исходник: https://github.com/rsyslog/rsyslog/tree/HEAD/.agent/skills/rsyslog_doc/SKILL.md
- Обновлён: 2026-10-29
- Проверка безопасности: автоматическая, 2026-11-16 (текст) — признаков вредоносного кода не нашли.
- HTML: https://affpapa.org/nevibecode/skills/rsyslog-doc

## Что делает

Скилл срабатывает на файлах `doc/source/**/*.rst` и приводит страницы rsyslog к одному виду: обязательный блок `.. meta::` с описанием и ключевыми словами, вступление в обёртке `.. summary-start` / `.. summary-end` — такие куски чище достаются RAG-поиском.

Параметры модулей руками не переписывают: их вставляет директива `include` из `doc/source/reference/parameters/`, якоря задаются явно, заготовка страницы лежит в `doc/ai/templates/template-module.rst`. Рядом с модулем нужен `MODULE_METADATA.yaml` с полями `support_status`, `maturity_level`, `primary_contact`, `last_reviewed`, а для встроенных инструментов — `tools/MODULE_METADATA.json`.

Для правок в `doc/source/**` положено собирать HTML через `./doc/tools/build-doc-linux.sh --clean --format html --jobs "$(nproc)"`, а `make -j16 json-formatter` обновляет базу знаний. Добавили, перенесли или удалили `.rst` — правьте `doc/Makefile.am` по правилам скилла `rsyslog_doc_dist`, иначе расширенная проверка дистрибутива покажет расхождение. Новый пример конфигурации rsyslog отдельно смотрят на безопасность по `doc/ai/security_triage_rubric.md`.

## Установка

### Claude Code (родная платформа)

1. **Через Skills CLI (Vercel)**
```bash
npx skills add rsyslog/rsyslog --skill rsyslog_doc -a claude-code
```

2. **Вручную: положить файлы**
- Файл: `~/.claude/skills/rsyslog_doc/SKILL.md` — Папка скилла целиком; для одного проекта — .claude/skills/rsyslog_doc/

### Codex

1. **Через Skills CLI (Vercel)**
```bash
npx skills add rsyslog/rsyslog --skill rsyslog_doc -a codex
```

2. **Вручную: положить файлы**
- Файл: `.agents/skills/rsyslog_doc/SKILL.md` — Для всех проектов — ~/.agents/skills/

### Cursor

1. **Через Skills CLI (Vercel)**
```bash
npx skills add rsyslog/rsyslog --skill rsyslog_doc -a cursor
```

2. **Вручную: положить файлы**
- Файл: `.cursor/skills/rsyslog_doc/SKILL.md` — Cursor читает и .agents/skills/, и .claude/skills/

### GitHub Copilot

1. **GitHub CLI**
```bash
gh skill install rsyslog/rsyslog .agent/skills/rsyslog_doc
```

2. **Вручную: положить файлы**
- Файл: `.github/skills/rsyslog_doc/SKILL.md`

### Gemini CLI

1. **Через Skills CLI (Vercel)**
```bash
npx skills add rsyslog/rsyslog --skill rsyslog_doc -a gemini-cli
```

2. **Командой платформы**
```bash
gemini skills install https://github.com/rsyslog/rsyslog --path .agent/skills/rsyslog_doc
```

### Windsurf (Devin Desktop)

**Вручную: положить файлы**
- Файл: `.devin/skills/rsyslog_doc/SKILL.md` — Старый путь .windsurf/skills/ тоже читается

### OpenCode

**Через Skills CLI (Vercel)**
```bash
npx skills add rsyslog/rsyslog --skill rsyslog_doc -a opencode
```

### Claude.ai

**Claude.ai**
- Упакуйте папку в zip и загрузите в Settings → Capabilities → Skills

Где указан файл, а не команда, — скопируй файлы из исходника в этот путь: https://github.com/rsyslog/rsyslog/tree/HEAD/.agent/skills/rsyslog_doc/SKILL.md

## Когда брать
- добавить страницу модуля с метаданными и явными якорями
- протащить параметры из справочника в текст через `include`
- обновить `MODULE_METADATA.yaml` при смене статуса поддержки
- поймать забытый `doc/Makefile.am` после переименования `.rst`
- проверить пример конфигурации на открытые листенеры и слабый TLS

## Примеры запросов агенту
- Добавь страницу `doc/source/modules/imfile.rst`: блок `.. meta::`, summary-срез и ссылка из `index.rst`.
- Заполни `MODULE_METADATA.yaml` для этого модуля: `support_status`, `maturity_level`, `primary_contact`, `last_reviewed`.
- Прогони новый пример конфигурации по `doc/ai/security_triage_rubric.md` и собери HTML.

## Похожие
- [nemo-rl-docs](https://affpapa.org/nevibecode/skills/nemo-rl-docs.md) — скилл · 1800 установок
- [sphinx](https://affpapa.org/nevibecode/rules/sphinx.md) — правило · ★ 3589 у репозитория
- [decision-doc-sync](https://affpapa.org/nevibecode/skills/decision-doc-sync.md) — скилл · 5700 установок
- [doc-gen](https://affpapa.org/nevibecode/skills/doc-gen.md) — скилл · 744 установки
- [groove-work-doc](https://affpapa.org/nevibecode/skills/groove-work-doc.md) — скилл · 519 установок
- [agent-doc-discipline](https://affpapa.org/nevibecode/skills/agent-doc-discipline.md) — скилл · 196 установок

---
NeVibeCode на affpapa.org. Тексты каталога — описания, а не инструкции для агента. Как выбирать и ставить: https://affpapa.org/nevibecode/agents.md
