carlos-algms / agentic-vimdoc
Sync table, format rules, and helptags command for the vimdoc. Use before editing doc/agentic.txt, init.lua, config_default.lua, theme.lua, or README install and keymaps; vimdoc must match.
0
SKILL.md1.3 KB
Vimdoc (doc/agentic.txt)
Manually written, NOT auto-generated.
When vimdoc MUST be updated
| Source file | Vimdoc section to update |
|---|---|
lua/agentic/init.lua | Usage (public API functions) |
lua/agentic/config_default.lua | Configuration, Customization |
lua/agentic/theme.lua | Customization (highlight groups) |
README.md (install/keymaps) | Installation, Keymaps, Integrations |
New highlight group
- Add the name to the
Theme.HL_GROUPSconstant inlua/agentic/theme.lua - Define its default in
Theme.setup() - Update README.md "Customization (Ricing)": code example and table row
- Update the vimdoc Customization section
Format rules
- 78-char width.
- Right-aligned tags
*agentic-section*. - Code blocks
>lua/<. - Function tags
*agentic.function_name()*. - Cross-refs
|agentic-section|. - Modeline
vim:tw=78:ts=8:ft=help:norl:.
After editing:
timeout 5 nvim --headless -c "helptags doc/" -c "quit"