docs: add Vim/Neovim setup guide#33
Merged
theDakshJaitly merged 2 commits intotheDakshJaitly:mainfrom Apr 17, 2026
Merged
Conversation
vim.fn.readfile() returns a list of lines; wrap with table.concat so the generic-plugin example matches the string type system_prompt fields expect.
theDakshJaitly
approved these changes
Apr 17, 2026
Owner
theDakshJaitly
left a comment
There was a problem hiding this comment.
LGTM — thanks for the clear, scoped guide. Pushed one small fix on top: vim.fn.readfile() returns a list of lines, so the generic-plugin snippet needed table.concat(..., "\n") to produce a string that plugins can feed into system_prompt.
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
What
Adds
docs/vim-neovim.md, a standalone Neovim setup guide for mex, and links it from the Multi-Tool Compatibility section ofREADME.md.The guide covers four setups:
:term claude+ existingCLAUDE.md).mex/ROUTER.md.github/copilot-instructions.md(setup.shoption 4).mex/ROUTER.mdinto the system prompt, or paste a one-line instruction telling the plugin to read it from the cwdWhy
Closes #14.
Vim/Neovim users can use mex today because the scaffold is tool-agnostic, but the README's Multi-Tool Compatibility table only names the configs the other editors consume. There's no guide for wiring up Neovim's common AI plugins, so users were left to improvise. The new guide lists each working path and the exact
setup.shoption (or plugin config snippet) that produces it.Type of change
How to test
docs/vim-neovim.mdand follow one of the sections.:term claude, and confirm Claude picks upCLAUDE.mdautomatically. This was tested end-to-end..mex/ROUTER.md,setup.shoption 4, option 8) that already exists in this repo.Checklist
docs/vim-neovim.md(new) and the single README paragraph linking it.Fixes #14
This contribution was developed with AI assistance (Codex).