From b4825f267d9c8867e1afd8175d6a913aba0343e8 Mon Sep 17 00:00:00 2001 From: Zhe Yu Date: Tue, 20 May 2025 17:52:10 +0800 Subject: [PATCH 1/4] some documentation updates. --- README.md | 33 +++++++++++++++++++++++++++++---- docs/cli.md | 4 ++++ 2 files changed, 33 insertions(+), 4 deletions(-) diff --git a/README.md b/README.md index 35d7f9b1..7975894e 100644 --- a/README.md +++ b/README.md @@ -10,9 +10,8 @@ repository you're working on. This repository also contains the corresponding neovim plugin because that's what I used to write this tool. > [!NOTE] -> This project is in beta quality and only implements very basic retrieval and -> embedding functionalities. There are plenty of rooms for improvements and any -> help is welcomed. +> This project is in beta quality and is undergoing rapid iterations. +> I know there are plenty of rooms for improvements, and any help is welcomed. > [!NOTE] > [Chromadb](https://www.trychroma.com/), the vector database backend behind @@ -24,8 +23,10 @@ neovim plugin because that's what I used to write this tool. * [Why VectorCode?](#why-vectorcode) * [Documentation](#documentation) + * [About Versioning](#about-versioning) * [TODOs](#todos) * [Credit](#credit) +* [Star History](#star-history) @@ -59,6 +60,23 @@ If you're trying to contribute to this project, take a look at [the contribution guide](./docs/CONTRIBUTING.md), which contains information about some basic guidelines that you should follow and tips that you may find helpful. +### About Versioning + +This project follows an adapted semantic versioning: + +- Until 1.0.0 is released, the _major version number_ stays 0 which indicates that + this project is still in early stage, and features/interfaces may change from + time to time; +- The _minor version number_ indicates __breaking changes__. When I decide to remove a + feature/config option, the actual removal will happen when I bump the minor + version number. Therefore, if you want to avoid breaking a working setup, you + may choose to use a version constraint like `"vectorcode<0.7.0"`; +- The _patch version number_ indicates __non-breaking changes__. This can include new + features and bug fixes. When I decide to deprecate things, I will make a new + release with bumped patch version. Until the minor version number is bumped, + the deprecated feature will still work but you'll see a warning. It's + recommended to update your setup to adapt the new features. + ## TODOs - [x] query by ~file path~ excluded paths; - [x] chunking support; @@ -79,7 +97,10 @@ guidelines that you should follow and tips that you may find helpful. **Implemented project-level `.vectorcode/` and `.git` as root anchor** - [ ] ability to view and delete files in a collection (atm you can only `drop` and `vectorise` again); -- [x] joint search (kinda, using codecompanion.nvim/MCP). +- [x] joint search (kinda, using codecompanion.nvim/MCP); +- [-] Nix support (#144); +- [-] Query rewriting (#124). + ## Credit @@ -89,3 +110,7 @@ guidelines that you should follow and tips that you may find helpful. 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). + +## Star History + +[![Star History Chart](https://api.star-history.com/svg?repos=Davidyz/VectorCode&type=Date)](https://www.star-history.com/#Davidyz/VectorCode&Date) diff --git a/docs/cli.md b/docs/cli.md index bea7012f..c5931da9 100644 --- a/docs/cli.md +++ b/docs/cli.md @@ -358,6 +358,10 @@ The JSON configuration file may hold the following values: to automatically detect the encoding, but this is not very accurate, especially on small files. +See +[the wiki](https://github.com/Davidyz/VectorCode/wiki/Default-Configuration#default-cli-configuration) +for an example of the default configuration. + ### Vectorising Your Code Run `vectorcode vectorise ` or `vectorcode vectorise From c71a7e561ef7834d84b92efa8f29a10affe117a8 Mon Sep 17 00:00:00 2001 From: Zhe Yu Date: Wed, 21 May 2025 17:45:56 +0800 Subject: [PATCH 2/4] update plugin installation instructions --- docs/neovim.md | 8 ++++---- 1 file changed, 4 insertions(+), 4 deletions(-) diff --git a/docs/neovim.md b/docs/neovim.md index 523eb594..54bc2f1b 100644 --- a/docs/neovim.md +++ b/docs/neovim.md @@ -37,12 +37,12 @@ ## Installation -Use your favourite plugin manager. +Use your favorite plugin manager. ```lua { "Davidyz/VectorCode", - version = "*", -- optional, depending on whether you're on nightly or release + version = "<0.7.0", -- optional, depending on whether you're on nightly or release dependencies = { "nvim-lua/plenary.nvim" }, cmd = "VectorCode", -- if you're lazy-loading VectorCode } @@ -69,8 +69,8 @@ you can use the following plugin spec: ```lua { "Davidyz/VectorCode", - version = "*", -- optional, depending on whether you're on nightly or release - build = "pipx upgrade vectorcode", -- optional but recommended if you set `version = "*"` + version = "*", + build = "pipx upgrade vectorcode", -- recommended if you set `version = "*"` or follow the main branch dependencies = { "nvim-lua/plenary.nvim" }, } ``` From 2dc6757a13af56d920cce25208a1ad1cf411d5e5 Mon Sep 17 00:00:00 2001 From: Davidyz Date: Wed, 21 May 2025 09:46:37 +0000 Subject: [PATCH 3/4] Auto generate docs --- doc/VectorCode.txt | 8 ++++---- 1 file changed, 4 insertions(+), 4 deletions(-) diff --git a/doc/VectorCode.txt b/doc/VectorCode.txt index 02b0e6aa..1baec115 100644 --- a/doc/VectorCode.txt +++ b/doc/VectorCode.txt @@ -47,12 +47,12 @@ Table of Contents *VectorCode-table-of-contents* INSTALLATION *VectorCode-neovim-plugin-installation* -Use your favourite plugin manager. +Use your favorite plugin manager. >lua { "Davidyz/VectorCode", - version = "*", -- optional, depending on whether you're on nightly or release + version = "<0.7.0", -- optional, depending on whether you're on nightly or release dependencies = { "nvim-lua/plenary.nvim" }, cmd = "VectorCode", -- if you're lazy-loading VectorCode } @@ -79,8 +79,8 @@ you can use the following plugin spec: >lua { "Davidyz/VectorCode", - version = "*", -- optional, depending on whether you're on nightly or release - build = "pipx upgrade vectorcode", -- optional but recommended if you set `version = "*"` + version = "*", + build = "pipx upgrade vectorcode", -- recommended if you set `version = "*"` or follow the main branch dependencies = { "nvim-lua/plenary.nvim" }, } < From 9f62fd8ee02222949c220466ae6926352b159202 Mon Sep 17 00:00:00 2001 From: Zhe Yu Date: Wed, 21 May 2025 17:52:36 +0800 Subject: [PATCH 4/4] github doesn't support intermediate checkbox so.. --- README.md | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/README.md b/README.md index 7975894e..4de4428e 100644 --- a/README.md +++ b/README.md @@ -90,7 +90,7 @@ This project follows an adapted semantic versioning: been indexed~ Returns empty array instead; - [x] job pool for async caching; - [x] [persistent-client](https://docs.trychroma.com/docs/run-chroma/persistent-client); -- [-] proper [remote Chromadb](https://docs.trychroma.com/production/administration/auth) support (with authentication, etc.); +- [ ] proper [remote Chromadb](https://docs.trychroma.com/production/administration/auth) support (with authentication, etc.); - [x] respect `.gitignore`; - [x] implement some sort of project-root anchors (such as `.git` or a custom `.vectorcode.json`) that enhances automatic project-root detection. @@ -98,8 +98,8 @@ This project follows an adapted semantic versioning: - [ ] ability to view and delete files in a collection (atm you can only `drop` and `vectorise` again); - [x] joint search (kinda, using codecompanion.nvim/MCP); -- [-] Nix support (#144); -- [-] Query rewriting (#124). +- [ ] Nix support (#144); +- [ ] Query rewriting (#124). ## Credit