# Agentic Vimdoc

> Use when writing or updating agentic.nvim vimdoc (doc/agentic.txt), or after changing init.lua, config_default.lua, theme.lua, or README install/keymaps - those edits require a matching vimdoc update. Covers the sync table, format rules, and the helptags regeneration command.

- Skill: `carlos-algms/agentic-vimdoc` (Agent Skill)
- Install (CLI): `npx skillmds@latest add carlos-algms/agentic-vimdoc`
- Raw SKILL.md: https://api.skillmd.com/api/skills/carlos-algms/agentic-vimdoc/raw
- Safety review: pending
- Works with: Claude Code, Claude.ai, OpenAI Codex
- Category: Coding & Dev Tools
- Author: carlos-algms (https://skillmd.com/u/carlos-algms)
- Updated: 2026-09-17
- Page: https://skillmd.com/skills/carlos-algms/agentic-vimdoc

---


# 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 |

## 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:

```bash
timeout 5 nvim --headless -c "helptags doc/" -c "quit"
```