// Use when neovim documentation is needed for the current task or the user asks for specific neovim features or neovim lua apis. It gives instructions on how to read current Neovim's documentation locally and offline, and also how to read online if it fails
| name | neovim-documentation |
| description | Use when neovim documentation is needed for the current task or the user asks for specific neovim features or neovim lua apis. It gives instructions on how to read current Neovim's documentation locally and offline, and also how to read online if it fails |
CRITICAL: Do NOT run nvim --headless or any other nvim command to read
help documentation. Use direct file access instead.
Why: Running nvim commands can hang, cause race conditions, or interfere
with development environment.
Always prefer reading local documentation files directly from the Neovim runtime path, because they reflect the exact version installed on the system.
Common path patterns for discovery:
/opt/homebrew/Cellar/neovim/*/share/nvim/runtime/doc/* to match
the installed version/snap/nvim/current/usr/bin/nvim
/snap/nvim/current/usr/share/nvim/runtime/doc/If local lookup fails: Use GitHub raw URLs (least preferred)
https://raw.githubusercontent.com/neovim/neovim/refs/tags/v<version>/runtime/doc/<doc-name>.txt
Tip: Do not assume a file contains what you need, use rg, or grep on the
runtime/doc folder to find the file containing needed info.
Use when ACP schema is necessary to clarify the work or when the user asks for ACP data, rules, events, or documentation
Use when creating new lua classes or adding fields or methods to existing lua classes. It gives guide lines on how to work with Lua classes and style guides that must be followed in this project
Use when creating, listing, or managing GitHub discussions in carlos-algms/agentic.nvim repository