rsyslog-doc

Skill rsyslog_doc zapewnia wytyczne do tworzenia spójnej, zoptymalizowanej dla AI dokumentacji. Każdy plik .rst musi zawierać blok metadanych, streszczenia oznaczone tagami summary-start i summary-end, oraz jawne kotwice dla linków. Skill automatycznie monitoruje zmiany w katalogach doc/source/**/*.rst i wymusza aktualizację mapy modułów oraz pliku Makefile.am. Dzięki temu dokumentacja pozostaje łatwa do odnalezienia zarówno dla czytelników, jak i systemów wzbogaconego wyszukiwania (RAG).

1. Zainstaluj skill w swoim repozytorium rsyslog, umieszczając go w katalogu .agent/skills/rsyslog_doc. Skill automatycznie aktywuje się przy każdej zmianie plików w ścieżce doc/source/**/*.rst.
2. Przy tworzeniu lub edycji dokumentacji dodaj blok metadanych na początku każdego pliku .rst zawierający :description: dla SEO i systemów RAG oraz :keywords: z istotnymi słowami kluczowymi.
3. Opakuj wprowadzenie i kluczowe sekcje dokumentu tagami .. summary-start i .. summary-end, aby wyodrębnić treść istotną dla systemów wzbogaconego wyszukiwania.
4. Dla dokumentacji modułów użyj dyrektywy include do importowania szczegółów parametrów z doc/source/reference/parameters/ i zdefiniuj jawne kotwice (np. .. _parameter_name:) dla spójnych linków.
5. Zaktualizuj plik doc/ai/module_map.yaml oraz index.rst aby odzwierciedlić nowe lub zmienione strony. Jeśli dodajesz, przesuwasz lub usuwasz plik .rst, uruchom skill rsyslog_doc_dist aby zaktualizować doc/Makefile.am.
6. Zweryfikuj poprawność dokumentacji uruchamiając ./doc/tools/build-doc-linux.sh --clean --format html, a następnie make -j16 json-formatter aby odświeżyć bazę wiedzy RAG.