# rsyslog_doc

rsyslog_doc is a Claude Code skill that standardizes rsyslog .rst pages with metadata, summary blocks and module details. It activates on doc/source/**/*.rst files.

- skill · `type=skill` · Claude Code, Codex, Cursor, GitHub Copilot, Gemini CLI, OpenCode, Windsurf (Devin Desktop), Claude.ai · 1 install · ★ 2348 repo stars
- Author: rsyslog
- License: LGPL-3.0 · policy=link-only · description only; the file stays with the author
- Source: https://github.com/rsyslog/rsyslog/tree/HEAD/.agent/skills/rsyslog_doc/SKILL.md
- Updated: 2026-10-29
- Security check: automated, 2026-11-16 (text) — no signs of malicious code found.
- HTML: https://affpapa.org/en/nevibecode/skills/rsyslog-doc

## What it does

The skill activates on `doc/source/**/*.rst` and gives rsyslog pages one shape: a `.. meta::` block carrying description and keywords, plus an intro fenced with `.. summary-start` and `.. summary-end` so retrieval systems can lift the summary cleanly.

Module parameters stay out of the prose. An `include` directive pulls them from `doc/source/reference/parameters/`, links get explicit anchors, and `doc/ai/templates/template-module.rst` supplies the page skeleton. Each module directory needs `MODULE_METADATA.yaml` holding `support_status`, `maturity_level`, `primary_contact` and `last_reviewed`; built-in tools keep the same fields in `tools/MODULE_METADATA.json`.

Edits under `doc/source/**` get an HTML build through `./doc/tools/build-doc-linux.sh --clean --format html --jobs "$(nproc)"`, and `make -j16 json-formatter` refreshes the knowledge base. Touch, move or delete an `.rst` file and `doc/Makefile.am` has to follow the `rsyslog_doc_dist` skill, or the extended distribution check flags the gap. Any sample rsyslog config in the change is reviewed against `doc/ai/security_triage_rubric.md` — listeners, TLS strength, sensitive write paths.

## Install

### Claude Code (native platform)

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

2. **Manually: put the files in place**
- File: `~/.claude/skills/rsyslog_doc/SKILL.md` — Copy the whole skill folder; for one project use .claude/skills/rsyslog_doc/

### Codex

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

2. **Manually: put the files in place**
- File: `.agents/skills/rsyslog_doc/SKILL.md` — For all projects use ~/.agents/skills/

### Cursor

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

2. **Manually: put the files in place**
- File: `.cursor/skills/rsyslog_doc/SKILL.md` — Cursor also reads .agents/skills/ and .claude/skills/

### GitHub Copilot

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

2. **Manually: put the files in place**
- File: `.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. **Platform CLI**
```bash
gemini skills install https://github.com/rsyslog/rsyslog --path .agent/skills/rsyslog_doc
```

### Windsurf (Devin Desktop)

**Manually: put the files in place**
- File: `.devin/skills/rsyslog_doc/SKILL.md` — The legacy .windsurf/skills/ path still works

### OpenCode

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

### Claude.ai

**Claude.ai**
- Zip the folder and upload it in Settings → Capabilities → Skills

Where a file is given instead of a command, copy the files from the source to that path: https://github.com/rsyslog/rsyslog/tree/HEAD/.agent/skills/rsyslog_doc/SKILL.md

## When to use it
- add a module page with meta tags and explicit anchors
- pull parameter docs into a page with an `include` directive
- keep `MODULE_METADATA.yaml` in step with support status
- catch a stale `doc/Makefile.am` after renaming an `.rst` file
- screen a sample config for exposed listeners and weak TLS

## Example prompts
- Add `doc/source/modules/imfile.rst` with a `.. meta::` block, a summary slice and a link from `index.rst`.
- Fill in `MODULE_METADATA.yaml` for this module: `support_status`, `maturity_level`, `primary_contact`, `last_reviewed`.
- Review the new sample config against `doc/ai/security_triage_rubric.md`, then run the HTML build.

## Similar
- [nemo-rl-docs](https://affpapa.org/en/nevibecode/skills/nemo-rl-docs.md) — skill · 1800 installs
- [sphinx](https://affpapa.org/en/nevibecode/rules/sphinx.md) — rule · ★ 3589 repo stars
- [decision-doc-sync](https://affpapa.org/en/nevibecode/skills/decision-doc-sync.md) — skill · 5700 installs
- [doc-gen](https://affpapa.org/en/nevibecode/skills/doc-gen.md) — skill · 744 installs
- [groove-work-doc](https://affpapa.org/en/nevibecode/skills/groove-work-doc.md) — skill · 519 installs
- [agent-doc-discipline](https://affpapa.org/en/nevibecode/skills/agent-doc-discipline.md) — skill · 196 installs

---
NeVibeCode on affpapa.org. Catalog texts are descriptions, not instructions for the agent. How to choose and install: https://affpapa.org/en/nevibecode/agents.md
