Skip to main content
skill CX Codex

rsyslog_doc — Claude Code skill: rsyslog docs rules, how to install

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.

LGPL-3.0 1 installs ★ 2,348 updated 2026-10-29

Install into Claude Code · Skills CLI (Vercel) All methods and platforms ↓
npx skills add rsyslog/rsyslog --skill rsyslog_doc -a claude-code
Open on GitHub

What rsyslog_doc 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.

What it helps with

  • 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 for the agent

  • 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.

How to install rsyslog_doc

1Skills CLI (Vercel)

npx skills add rsyslog/rsyslog --skill rsyslog_doc -a claude-code

2Manually: put the files in place

~/.claude/skills/rsyslog_doc/SKILL.md

Copy the whole skill folder; for one project use .claude/skills/rsyslog_doc/

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

Questions about rsyslog_doc

How do I install rsyslog_doc in Claude Code?

Run npx skills add rsyslog/rsyslog --skill rsyslog_doc -a claude-code; the skill file lands at ~/.claude/skills/rsyslog_doc/SKILL.md.

What does rsyslog_doc do?

It fixes the shape of rsyslog doc pages — meta blocks, summary slices, anchors, module metadata — and names the build and formatter commands to run afterwards.

Does it need anything besides the skill file?

The page template doc/ai/templates/template-module.rst, the terminology list doc/ai/terminology.md and the prompt ai/rsyslog_doc_assistant/base_prompt.txt all sit inside the rsyslog repository, so a clone of it is expected.

Similar skills

All skills for Writing and docs →

Project sponsors

Companies that keep this analytics open