Auto generate docs

Author: Davidyz

doc/VectorCode-cli.txt

@@ -213,7 +213,7 @@ REFRESHING EMBEDDINGS ~
 
 To maintain the accuracy of the vector search, it’s important to keep your
 embeddings up-to-date. You can simply run the `vectorise` subcommand on a file
-to refresh the embedding for a particular file, and the CLI provides a
+to refresh the embedding for that file. Apart from that, the CLI provides a
 `vectorcode update` subcommand, which updates the embeddings for all files that
 are currently indexed by VectorCode for the current project.
 
@@ -242,8 +242,8 @@ For each project, VectorCode creates a collection (similar to tables in
 traditional databases) and puts the code embeddings in the corresponding
 collection. In the root directory of a project, you may run `vectorcode init`.
 This will initialise the repository with a subdirectory
-`project_root/.vectorcode/`. This will mark this directory a _project root_, a
-concept that will later be used to construct the collection. You may put a
+`project_root/.vectorcode/`. This will mark this directory as a _project root_,
+a concept that will later be used to construct the collection. You may put a
 `config.json` file in `project_root/.vectorcode`. This file may be used to
 store project-specific settings such as embedding functions and database entry
 point (more on this later). If you already have a global configuration file at
@@ -320,31 +320,32 @@ model_name="nomic-embed-text")`. Default: `{}`; - `db_url`string, the url that
 points to the Chromadb server. VectorCode will start an HTTP server for
 Chromadb at a randomly picked free port on `localhost` if your configured
 `http://host:port` is not accessible. Default: `http://127.0.0.1:8000`; -
-`db_path`string, Path to local persistent database. This is where the files for
-your database will be stored. Default: `~/.local/share/vectorcode/chromadb/`; -
-`db_log_path`string, path to the _directory_ where the built-in chromadb server
-will write the log to. Default: `~/.local/share/vectorcode/`; -
-`chunk_size`integer, the maximum number of characters per chunk. A larger value
-reduces the number of items in the database, and hence accelerates the search,
-but at the cost of potentially truncated data and lost information. Default:
-`2500`. To disable chunking, set it to a negative number; -
-`overlap_ratio`float between 0 and 1, the ratio of overlapping/shared content
-between 2 adjacent chunks. A larger ratio improves the coherences of chunks,
-but at the cost of increasing number of entries in the database and hence
-slowing down the search. Default: `0.2`. _Starting from 0.4.11, VectorCode will
-use treesitter to parse languages that it can automatically detect. It uses
-pygments to guess the language from filename, and tree-sitter-language-pack to
-fetch the correct parser. overlap_ratio has no effects when treesitter works.
-If VectorCode fails to find an appropriate parser, it’ll fallback to the
-legacy naive parser, in which case overlap_ratio works exactly in the same way
-as before;_ - `query_multiplier`integer, when you use the `query` command to
-retrieve `n` documents, VectorCode will check `n * query_multiplier` chunks and
-return at most `n` documents. A larger value of `query_multiplier` guarantees
-the return of `n` documents, but with the risk of including too many
-less-relevant chunks that may affect the document selection. Default: `-1` (any
-negative value means selecting documents based on all indexed chunks); -
-`reranker`string, the reranking method to use. Currently supports
-`CrossEncoderReranker` (default, using sentence-transformers cross-encoder
+`db_path`string, Path to local persistent database. If you didn’t set up a
+standalone Chromadb server, this is where the files for your database will be
+stored. Default: `~/.local/share/vectorcode/chromadb/`; - `db_log_path`string,
+path to the _directory_ where the built-in chromadb server will write the log
+to. Default: `~/.local/share/vectorcode/`; - `chunk_size`integer, the maximum
+number of characters per chunk. A larger value reduces the number of items in
+the database, and hence accelerates the search, but at the cost of potentially
+truncated data and lost information. Default: `2500`. To disable chunking, set
+it to a negative number; - `overlap_ratio`float between 0 and 1, the ratio of
+overlapping/shared content between 2 adjacent chunks. A larger ratio improves
+the coherence of chunks, but at the cost of increasing number of entries in the
+database and hence slowing down the search. Default: `0.2`. _Starting from
+0.4.11, VectorCode will use treesitter to parse languages that it can
+automatically detect. It uses pygments to guess the language from filename, and
+tree-sitter-language-pack to fetch the correct parser. overlap_ratio has no
+effects when treesitter works. If VectorCode fails to find an appropriate
+parser, it’ll fallback to the legacy naive parser, in which case
+overlap_ratio works exactly in the same way as before;_ -
+`query_multiplier`integer, when you use the `query` command to retrieve `n`
+documents, VectorCode will check `n * query_multiplier` chunks and return at
+most `n` documents. A larger value of `query_multiplier` guarantees the return
+of `n` documents, but with the risk of including too many less-relevant chunks
+that may affect the document selection. Default: `-1` (any negative value means
+selecting documents based on all indexed chunks); - `reranker`string, the
+reranking method to use. Currently supports `CrossEncoderReranker` (default,
+using sentence-transformers cross-encoder
 <https://sbert.net/docs/package_reference/cross_encoder/cross_encoder.html> )
 and `NaiveReranker` (sort chunks by the "distance" between the embedding
 vectors); - `reranker_params`dictionary, similar to `embedding_params`. The
@@ -353,17 +354,16 @@ these are the options passed to the `CrossEncoder`
 <https://sbert.net/docs/package_reference/cross_encoder/cross_encoder.html#id1>
 class. For example, if you want to use a non-default model, you can use the
 following: `json { "reranker_params": { "model_name_or_path": "your_model_here"
-} }` ; - `db_settings`dictionary, works in a similar way to `embedding_params`,
+} }` - `db_settings`dictionary, works in a similar way to `embedding_params`,
 but for Chromadb client settings so that you can configure authentication for
 remote Chromadb <https://docs.trychroma.com/production/administration/auth>; -
 `hnsw`a dictionary of hnsw settings
 <https://cookbook.chromadb.dev/core/configuration/#hnsw-configuration> that may
 improve the query performances or avoid runtime errors during queries. **It’s
 recommended to re-vectorise the collection after modifying these options,
 because some of the options can only be set during collection creation.**
-Example: `json5 // the following is the default value. "hnsw": { "hnsw:M": 64,
-}` - `filetype_map``dict[str, list[str]]`, a dictionary where keys are language
-name
+Example (and default): `json5 "hnsw": { "hnsw:M": 64, }` -
+`filetype_map``dict[str, list[str]]`, a dictionary where keys are language name
 <https://github.com/Goldziher/tree-sitter-language-pack?tab=readme-ov-file#available-languages>
 and values are lists of Python regex patterns
 <https://docs.python.org/3/library/re.html> that will match file extensions.
@@ -558,7 +558,7 @@ the `VECTORCODE_LOG_LEVEL` variable to one of `ERROR`, `WARN` (`WARNING`),
 `INFO` or `DEBUG`. For the CLI that you interact with in your shell, this will
 output logs to `STDERR` and write a log file to
 `~/.local/share/vectorcode/logs/`. For LSP and MCP servers, because `STDIO` is
-used for the RPC, only the log file will be written.
+used for the RPC, the logs will only be written to the log file, not `STDERR`.
 
 For example:
 
@@ -567,6 +567,9 @@ For example:
 <
 
 
+  Depending on the MCP/LSP client implementation, you may need to take extra
+  steps to make sure the environment variables are captured by VectorCode.
+
 SHELL COMPLETION*VectorCode-cli-vectorcode-command-line-tool-shell-completion*
 
 VectorCode supports shell completion for bash/zsh/tcsh. You can use `vectorcode
@@ -594,9 +597,9 @@ following options in the JSON config file:
 For Intel users, sentence transformer <https://www.sbert.net/index.html>
 supports OpenVINO
 <https://www.intel.com/content/www/us/en/developer/tools/openvino-toolkit/overview.html>
-backend for supported GPU. Run `pipx install vectorcode[intel]` which will
-bundle the relevant libraries when you install VectorCode. After that, you will
-need to configure `SentenceTransformer` to use `openvino` backend. In your
+backend for supported GPU. Run `uv install vectorcode[intel]` which will bundle
+the relevant libraries when you install VectorCode. After that, you will need
+to configure `SentenceTransformer` to use `openvino` backend. In your
 `config.json`, set `backend` key in `embedding_params` to `"openvino"`
 
 >json

doc/VectorCode.txt

@@ -21,7 +21,8 @@ Table of Contents                               *VectorCode-table-of-contents*
   proceeding.
 
   [!NOTE] When the neovim plugin doesn’t work properly, please try upgrading
-  the CLI tool to the latest version before opening an issue.
+  both the CLI and the neovim plugin to the latest version before opening an
+  issue.
 - |VectorCode-installation|
     - |VectorCode-nix|
 - |VectorCode-integrations|
@@ -49,7 +50,7 @@ Table of Contents                               *VectorCode-table-of-contents*
 
 INSTALLATION                           *VectorCode-neovim-plugin-installation*
 
-Use your favorite plugin manager.
+Using Lazy:
 
 >lua
     {
@@ -75,7 +76,7 @@ VectorCode CLI and pin to the releases for the neovim plugin;
 the latest GitHub commit.
 
 It may be helpful to use a `build` hook to automatically upgrade the CLI when
-the neovim plugin updates. For example, if you’re using lazy.nvim and `pipx`,
+the neovim plugin updates. For example, if you’re using lazy.nvim and `uv`,
 you can use the following plugin spec:
 
 >lua
@@ -105,13 +106,10 @@ The wiki <https://github.com/Davidyz/VectorCode/wiki/Neovim-Integrations>
 contains instructions to integrate VectorCode with the following plugins:
 
 - milanglacier/minuet-ai.nvim <https://github.com/milanglacier/minuet-ai.nvim>;
-- olimorris/codecompanion.nvim <https://github.com/olimorris/codecompanion.nvim> [^];
+- olimorris/codecompanion.nvim <https://github.com/olimorris/codecompanion.nvim>;
 - nvim-lualine/lualine.nvim <https://github.com/nvim-lualine/lualine.nvim>;
-- CopilotC-Nvim/CopilotChat.nvim <https://github.com/CopilotC-Nvim/CopilotChat.nvim> [^];
-- ravitemer/mcphub.nvim <https://github.com/ravitemer/mcphub.nvim>[^].
-
-For these plugins, having the plugin installed is sufficient. please go ahead
-to the wiki for further instructions.
+- CopilotC-Nvim/CopilotChat.nvim <https://github.com/CopilotC-Nvim/CopilotChat.nvim>;
+- ravitemer/mcphub.nvim <https://github.com/ravitemer/mcphub.nvim>.
 
 
 CONFIGURATION                         *VectorCode-neovim-plugin-configuration*
@@ -176,9 +174,9 @@ 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 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.
+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
@@ -190,6 +188,9 @@ configured.
 
 USER COMMAND                           *VectorCode-neovim-plugin-user-command*
 
+The neovim plugin provides user commands to work with
+|VectorCode-async-caching|.
+
 
 VECTORCODE REGISTER ~
 
@@ -307,6 +308,9 @@ path/document content to the prompt like this:
     end
 <
 
+Keep in mind that this `query` function call will be synchronous and therefore
+block the neovim UI. This is where the async cache comes in.
+
 
 CHECK(CHECK_ITEM?)
 
@@ -370,8 +374,8 @@ path to the executable) by calling `vim.lsp.config('vectorcode_server', opts)`.
 
   Cons       Heavy IO overhead because the   Requires vectorcode-server; Only
              embedding model and database    works if you’re using a standalone
-             client need to be initialised   ChromaDB server; May contain bugs
-             for every query.                because it’s new.
+             client need to be initialised   ChromaDB server.
+             for every query.                
   -------------------------------------------------------------------------------
 You may choose which backend to use by setting the |VectorCode-`setup`| option
 `async_backend`, and acquire the corresponding backend by the following API:
@@ -400,9 +404,9 @@ This function registers a buffer to be cached by VectorCode.
 <
 
 The following are the available options for this function: - `bufnr`buffer
-number. Default: current buffer; - `opts`accepts a lua table with the following
-keys: - `project_root`a string of the path that overrides the detected project
-root. Default: `nil`. This is mostly intended to use with the
+number. Default: `0` (current buffer); - `opts`accepts a lua table with the
+following keys: - `project_root`a string of the path that overrides the
+detected project root. Default: `nil`. This is mostly intended to use with the
 |VectorCode-user-command|, and you probably should not use this directly in
 your config. **If you’re using the LSP backend and did not specify this
 value, it will be automatically detected based on .vectorcode or .git. If this