From 1daa92ec54fd73052dabea32348c05f8792f40f7 Mon Sep 17 00:00:00 2001 From: Davidyz Date: Sat, 3 May 2025 10:30:38 +0800 Subject: [PATCH 1/2] docs(cli): update docs to mention the requirements for cpp/rust compilers. --- docs/cli.md | 6 +++++- 1 file changed, 5 insertions(+), 1 deletion(-) diff --git a/docs/cli.md b/docs/cli.md index 264de0bc..607f572f 100644 --- a/docs/cli.md +++ b/docs/cli.md @@ -38,7 +38,11 @@ ## Installation -After 0.1.3, the CLI supports Python 3.11~3.13. The recommended way of +> The CLI supports Python 3.11~3.13. You may also need a fairly recent c++/rust +compiler because the core components of the vector database (ChromaDB) contains +c++ and rust code. + +The recommended way of installation is through [`pipx`](https://pipx.pypa.io/stable/), which will create a virtual environment for the package itself that doesn't mess up with your system Python or project-local virtual environments. From 24f0988074c04c3531e98c11e6f1121e8ce5047a Mon Sep 17 00:00:00 2001 From: Zhe Yu Date: Tue, 6 May 2025 16:41:41 +0800 Subject: [PATCH 2/2] chore: update issue template --- .github/ISSUE_TEMPLATE/bug_report.md | 6 +++++- 1 file changed, 5 insertions(+), 1 deletion(-) diff --git a/.github/ISSUE_TEMPLATE/bug_report.md b/.github/ISSUE_TEMPLATE/bug_report.md index ce99793a..7f4ef913 100644 --- a/.github/ISSUE_TEMPLATE/bug_report.md +++ b/.github/ISSUE_TEMPLATE/bug_report.md @@ -50,4 +50,8 @@ attach the relevant config here: - OS: Linux, MacOS, Windows... **Additional context** -Add any other context about the problem here. +Add any other context about the problem here. Please attach +[CLI logs](https://github.com/Davidyz/VectorCode/blob/main/docs/cli.md#debugging-and-diagnosing) +or +[nvim plugin logs](https://github.com/Davidyz/VectorCode/blob/main/docs/neovim.md#debugging-and-logging) +if applicable.