Skip to content

docs: updated documentation #116

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
Davidyz merged 2 commits into from
May 7, 2025
Merged

docs: updated documentation #116

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
1daa92e
docs(cli): update docs to mention the requirements for cpp/rust compi…
Davidyz May 3, 2025
24f0988
chore: update issue template
May 6, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 5 additions & 1 deletion .github/ISSUE_TEMPLATE/bug_report.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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.
6 changes: 5 additions & 1 deletion docs/cli.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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.
Expand Down