Please considering improving/maintaning documentation

[playbahn]

Checked other resources

• This is not a bug report or feature request (Please use issues for those).
• This is a question about rustaceanvim, not rust-analyzer or Neovim.
• This is not a question about autocompletion.
• I have read the README.
• I have read the FAQ.
• I have searched for a solution using :h rustaceanvim.
• I have searched existing discussions.
• I have searched the existing issues/discussions of other plugins related to this question (if applicable).
• I have searched the existing rust-analyzer discussions (if applicable).
• I have added a very descriptive title to this question.

Description

First things first, I'm new to Neovim.

• I'm trying to setup (auto)completion for rust.

• https://github.com/mrcjkb/rustaceanvim?tab=readme-ov-file#how-to-enable-auto-completion says

  This plugin will automatically register the necessary client capabilities if you have either cmp-nvim-lsp or blink.cmp installed.

• One of the features blink.cmp has is auto completion of brackets, which seems to be enabled by default blink, but its not working, which implies this:

  This plugin will automatically register the necessary client capabilities

  is not happening. $ rg -e "blink|cmp" in the repo returns no source files. Maybe the automatic registering is not happening anymore?

• I then tried to set up the capabilities, found around the internet people passing them inside vim.g.rustaceanvim.server, which is rustaceanvim.lsp.ClientOpts. :h rustaceanvim shows rustaceanvim.lsp.ClientOpts having only auto_attach, cmd, root_dir, ra_multiplex fields.

• After cloning the repo, searching for "capabilities", going to

  rustaceanvim/lua/rustaceanvim/config/internal.lua

  Line 259 in 628ff01

  ---@class rustaceanvim.lsp.ClientConfig: vim.lsp.ClientConfig

  reveals server is also/actually a rustaceanvim.lsp.ClientConfig: vim.lsp.ClientConfig. Finally it made sense to me how people were passing capabilities inside vim.g.rustaceanvim.server. EDIT: Please keep just one of the names rustaceanvim.lsp.ClientConfig or rustaceanvim.lsp.ClientOpts, not both. Its confusing.

• The docs do say:

  These can also be set using |vim.lsp.config()| for "rust-analyzer" or "*". If both the server table and a vim.lsp.config["rust-analyzer"] are defined, rustaceanvim merges |vim.lsp.config()| settings into the server table, giving them precedence over existing settings.

  This kind of connects vim.g.rustaceanvim.server to vim.lsp.ClientConfig, but still, :h vim.lsp.config() reveals the {cfg} for vim.lsp.config() is vim.lsp.Config and :h vim.lsp.Config finally reveals that vim.lsp.Config extends vim.lsp.ClientConfig. As someone new to the whole Neovim ecosystem, this was a bit hard for me. So, please consider improving/maintaning the docs.

I would consider contributing to the docs, but I only know lua for the sake of Neovim.

Example Code

struct Abc {

Neovim version (nvim -v)

NVIM v0.11.2

Operating system/version

Arch Linux

Output of :checkhealth rustaceanvim

==============================================================================
rustaceanvim:                                                             1 ⚠️

Checking for Lua dependencies ~
- ⚠️ WARNING optional dependency nvim-dap is configured, but not installed. Needed for debugging features [mfussenegger/nvim-dap](https://github.com/mfussenegger/nvim-dap)

Checking external dependencies ~
- ✅ OK rust-analyzer: found rust-analyzer 1.88.0 (6b00bc3 2025-06-23)
- ✅ OK Cargo: found cargo 1.88.0 (873a06493 2025-05-10)
- ✅ OK rustc: found rustc 1.88.0 (6b00bc388 2025-06-23)
- ✅ OK debug adapter: found codelldb 

Checking config ~
- ✅ OK No errors found in config.

Checking for conflicting plugins ~
- ✅ OK No conflicting plugins detected.

Checking for tree-sitter parser ~
- ✅ OK tree-sitter parser for Rust detected.

[mrcjkb]

This plugin will automatically register the necessary client capabilities

I removed this feature in version 6.0.
It's the responsibility of the completion plugins to register their own capabilities, not rustaceanvim's.

I cannot provide documentation for other plugins in rustaceanvim's documentation, as that is likely to break all change without my control.

As someone new to the whole Neovim ecosystem, this was a bit hard for me. So, please consider improving/maintaning the docs.

This is normal when you're new to Neovim. I suggest you learn how to navigate Neovim help tags.
Neovim documentation improvements is an ongoing topic, beyond the scope of rustaceanvim.