RAG-ing the neovim lua API and docs!

[Davidyz]

A typical installation of our favourite text editor comes with various plain-text runtime files, including vimscript/lua source code for built-in functions and APIs, as well as corresponding documentation for them. On my system (Arch Linux, btw), the runtime can be found at /usr/share/nvim/runtime. Conveniently, VectorCode provides a --project_root flag, which allows you to operate on a project without being in that directory (or without having a .git or .vectorcode to mark a project root). Therefore, you can do the following:

vectorcode vectorise --project_root /usr/share/nvim/runtime /usr/share/nvim/runtime/**/*.{txt,lua}

This will create a collection for the neovim runtime, containing embeddings for Neovim Lua source code and documentation:

$ vectorcode ls
Project Root                Collection Size    Number of Files  Embedding Function
------------------------  -----------------  -----------------  ------------------------------------
~/git/codecompanion.nvim                208                104  SentenceTransformerEmbeddingFunction
~/git/VectorCode                        122                 61  SentenceTransformerEmbeddingFunction
/usr/share/nvim/runtime                 558                279  SentenceTransformerEmbeddingFunction

Now, if you open a codecompanion chat and ask the LLM to use the @vectorcode tool to answer neovim-related questions, it'll be able to query from the collection that we created for /usr/share/nvim/runtime and provide accurate answers!

The only thing you'd need to take care of is that you need to re-vectorise when you upgrade neovim. This wouldn't happen very often for stable users, but for people who chase the nightly build of neovim, this could be a little bit inconvenient.