rsyslog/rsyslog
1
0
Fork 0
mirror of https://github.com/rsyslog/rsyslog.git synced 2026-06-19 10:32:55 +02:00
Code Issues Packages Projects Releases Wiki Activity
rsyslog/doc/AGENTS.md
Rainer Gerhards 2f4ebd9a99 core: streamline agent instructions with modular skills 
Modernize the rsyslog contribution workflow for AI agents to
improve policy compliance and reduce instruction verbosity.

Impact: Repository-wide reduction in AGENTS.md bloat.

Before: Fragmented and redundant procedural instructions in AGENTS.md.
After: Modular skills in .agent/skills/ with streamlined subtree guides.

This change encapsulates build, test, documentation, module authoring,
and commit policies into reusable skills. It introduces:
- A specialized AI memory lifecycle auditor.
- A boilerplate snippets library.
- The 'rsyslog_doc_dist' skill for doc/Makefile.am synchronization.
- YAML frontmatter 'triggers' for automatic skill activation.

The workflow is further optimized to skip redundant builds after stylistc
code formatting, ensuring faster iteration for AI-led development.

AI-Agent: Antigravity 2026-01
2026-01-23 13:52:13 +01:00

945 B
Raw Blame History

AGENTS.md – Documentation subtree

This guide applies to everything under doc/.

Workflow & Skills

AI agents working on documentation MUST use the standardized skills in .agent/skills/:

  • Doc: Use rsyslog_doc for metadata blocks, summary slices, and Sphinx validation.
  • Dist: Use rsyslog_doc_dist for doc/Makefile.am synchronization.
  • Commit: Use rsyslog_commit for doc-specific commit trailers.

Subtree Specifics

  • Knowledge Base: doc/ai/ contains canonical guides for Mermaid, Terminology, and authoring.
  • Prompting: Use ai/rsyslog_code_doc_builder/base_prompt.txt for tone and style guidance.
  • Build: Use ./doc/tools/build-doc-linux.sh --clean --format html for validation.

For detailed authoring rules, see doc/ai/AGENTS.md.