# Agentic Vimdoc

> Agentic Vimdoc is an Agent Skill for documents published in the carlos-algms/agentic.nvim repository on GitHub: a SKILL.md instruction file an AI agent can load to do this task.

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 name: `agentic-vimdoc`
- Category: [Documents](https://www.openparable.com/skill/documents/1)
- Source: https://github.com/carlos-algms/agentic.nvim/blob/HEAD/.agents/skills/agentic-vimdoc/SKILL.md
- Repository: carlos-algms/agentic.nvim (561 GitHub stars when collected)

## SKILL.md

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

---

Source: https://www.openparable.com/skill/documents/agentic-vimdoc (OpenParable). Cite the canonical URL above.