docs: Readme updates (#233)

* docs(nvim): Add instructions for mason installation

* Auto generate docs

* docs: Update credits and add nix community

* docs(nvim): Clarify lazy-loading behavior for LSP server startup

* Auto generate docs

---------

Co-authored-by: Davidyz <Davidyz@users.noreply.github.com>

Author: Davidyz

README.md

@@ -102,12 +102,14 @@ This project follows an adapted semantic versioning:
 
 ## Credit
 
-- Thank [@milanglacier](https://github.com/milanglacier) (and [minuet-ai.nvim](https://github.com/milanglacier/minuet-ai.nvim)) for the support when this project was still in early stage;
-- Thank [@olimorris](https://github.com/olimorris) for the help (personally and
+- [@milanglacier](https://github.com/milanglacier) (and [minuet-ai.nvim](https://github.com/milanglacier/minuet-ai.nvim)) for the support when this project was still in early stage;
+- [@olimorris](https://github.com/olimorris) for the help (personally and
   from [codecompanion.nvim](https://github.com/olimorris/codecompanion.nvim))
   when this project made initial attempts at tool-calling;
-- Thank [@ravitemer](https://github.com/ravitemer) for the help to interface
-  VectorCode with [MCP](https://modelcontextprotocol.io/introduction).
+- [@ravitemer](https://github.com/ravitemer) for the help to interface
+  VectorCode with [MCP](https://modelcontextprotocol.io/introduction);
+- The nix community (especially [@sarahec](https://github.com/sarahec) and [@GaetanLepage](https://github.com/GaetanLepage))
+  for maintaining the nix packages.
 
 ## Star History
 

doc/VectorCode.txt

@@ -24,6 +24,7 @@ Table of Contents                               *VectorCode-table-of-contents*
   both the CLI and the neovim plugin to the latest version before opening an
   issue.
 - |VectorCode-installation|
+    - |VectorCode-mason.nvim|
     - |VectorCode-nix|
 - |VectorCode-integrations|
 - |VectorCode-configuration|
@@ -93,6 +94,13 @@ you can use the following plugin spec:
   This plugin is developed and tested on neovim _v0.11_. It may work on older
   versions, but I do not test on them before publishing.
 
+MASON.NVIM ~
+
+The VectorCode CLI and LSP server are available in `mason.nvim`. If you choose
+to install the CLI through mason, you may need to pay extra attention to the
+version pinning because the package updates on mason usually takes extra time.
+
+
 NIX ~
 
 There’s a community-maintained nix package
@@ -171,13 +179,14 @@ async backend to use, currently either `"default"` or `"lsp"`. Default:
 `setup` is called. Supported keys: - `update`if `true`, the plugin will run
 `vectorcode update` on startup to update the embeddings; - `lsp`if `true`, the
 plugin will try to start the LSP server on startup so that you won’t need to
-wait for the server loading when making your first request. -
-`sync_log_env_var``boolean`. If true, this plugin will automatically set the
-`VECTORCODE_LOG_LEVEL` environment variable for LSP or cmd processes started
-within your neovim session when logging is turned on for this plugin. Use at
-caution because the non-LSP CLI write all logs to stderr, which _may_ make this
-plugin VERY verbose. See |VectorCode-debugging-and-logging| for details on how
-to turn on logging.
+wait for the server loading when making your first request. _Please pay extra
+attention on lazy-loading so that the LSP server won’t be started without a
+buffer to be attached to (see here)._ - `sync_log_env_var``boolean`. If true,
+this plugin will automatically set the `VECTORCODE_LOG_LEVEL` environment
+variable for LSP or cmd processes started within your neovim session when
+logging is turned on for this plugin. Use at caution because the non-LSP CLI
+write all logs to stderr, which _may_ make this plugin VERY verbose. See
+|VectorCode-debugging-and-logging| for details on how to turn on logging.
 
 You may notice that a lot of options in `async_opts` are the same as the other
 options in the top-level of the main option table. This is because the

docs/neovim.md

@@ -12,6 +12,7 @@
 <!-- mtoc-start -->
 
 * [Installation](#installation)
+  * [Mason.nvim ](#masonnvim-)
   * [Nix](#nix)
 * [Integrations](#integrations)
 * [Configuration](#configuration)
@@ -80,6 +81,12 @@ you can use the following plugin spec:
 > This plugin is developed and tested on neovim _v0.11_. It may work on older
 > versions, but I do not test on them before publishing.
 
+### Mason.nvim 
+
+The VectorCode CLI and LSP server are available in `mason.nvim`. If you choose to
+install the CLI through mason, you may need to pay extra attention to the version 
+pinning because the package updates on mason usually takes extra time.
+
 ### Nix
 
 There's a community-maintained [nix package](https://nixpk.gs/pr-tracker.html?pr=413395) 
@@ -159,7 +166,8 @@ The following are the available options for the parameter of this function:
     update the embeddings;
   - `lsp`: if `true`, the plugin will try to start the LSP server on startup so
     that you won't need to wait for the server loading when making your first 
-    request.
+    request. _Please pay extra attention on lazy-loading so that the LSP server
+    won't be started without a buffer to be attached to (see [here](https://github.com/Davidyz/VectorCode/pull/234))._
 - `sync_log_env_var`: `boolean`. If true, this plugin will automatically set the
   `VECTORCODE_LOG_LEVEL` environment variable for LSP or cmd processes started
   within your neovim session when logging is turned on for this plugin. Use at