docs(install): add Katana install and WSL2 setup guide (#4109) #4110
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
juangcarmona
changed the title
zwpaper
requested changes
Apr 14, 2025
There was a problem hiding this comment.
Hi @juangcarmona, Thank you for the pr; it could enhance the Tabby user experience!
However, I have noticed an area that could be improved:
- Some files have been altered unnecessarily; this may be due to file mode changes. Please revert these modifications.
- Please divide this PR into two separate ones, each with a specific focus: one for the Katana changes, and another for the WSL.
| @@ -28,6 +28,23 @@ Running Tabby on Linux using Tabby's standalone executable distribution. | |||
| * Check your local CUDA version by running the following command in a terminal: `nvcc --version` | |||
| * For the Vulkan version you'll need the vulkan library. In ubuntu, this would be `sudo apt install libvulkan1`. | |||
|
|
|||
| ## Katana (optional but recommended) | |||
|
|
|||
| Tabby uses [Katana](https://github.com/projectdiscovery/katana) as a crawling backend for context providers. | |||
There was a problem hiding this comment.
Suggested change
| Tabby uses [Katana](https://github.com/projectdiscovery/katana) as a crawling backend for context providers. | |
| Tabby utilizes [Katana](https://github.com/projectdiscovery/katana) as a crawling backend for the `developer docs` context provider. |
| ## Katana (optional but recommended) | ||
|
|
||
| Tabby uses [Katana](https://github.com/projectdiscovery/katana) as a crawling backend for context providers. | ||
| If you want Tabby to **import and reason over documentation**, Katana is required. |
There was a problem hiding this comment.
Suggested change
| If you want Tabby to **import and reason over documentation**, Katana is required. | |
| To import and analyze `developer docs` when llms.txt is unavailable at the specified link, Katana is required. |
|
|
||
| Tabby uses [Katana](https://github.com/projectdiscovery/katana) as a crawling backend for context providers. | ||
| If you want Tabby to **import and reason over documentation**, Katana is required. | ||
|
|
There was a problem hiding this comment.
Suggested change
| Please be aware that the minimum Katana version required is `1.1.2`. |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Closes #4109 I created today
This PR improves the installation experience by updating the documentation for:
I tried to keep changes and additions as concise as possible . Please, let me know if you'd like the WSL2 page linked from the Windows doc sidebar too.
Thanks for this awesome project 🙌