diff --git a/website/docs/administration/context/code-browser-entry.png b/website/docs/administration/context/code-browser-entry.png new file mode 100644 index 000000000000..031aaa8d5a2a --- /dev/null +++ b/website/docs/administration/context/code-browser-entry.png @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:453f319961aaaf1ac58c4d7a224bece6d7a76606138d5724b122e2a1da4e23c2 +size 22048 diff --git a/website/docs/administration/context/code-browser.png b/website/docs/administration/context/code-browser.png index 94e5cd32820e..7bb9b2845293 100644 --- a/website/docs/administration/context/code-browser.png +++ b/website/docs/administration/context/code-browser.png @@ -1,3 +1,3 @@ version https://git-lfs.github.com/spec/v1 -oid sha256:75a1c5e7912a45018ec7a8455552e4c259447b544f46b579837ac7198cecedbb -size 56530 +oid sha256:420930c90b6b097764546e450d68a979554dd97ff6b98c4f49cf22db8f0228d7 +size 32531 diff --git a/website/docs/administration/context/context-providers.png b/website/docs/administration/context/context-providers.png new file mode 100644 index 000000000000..756411ca1adc --- /dev/null +++ b/website/docs/administration/context/context-providers.png @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:47aa2937ab453a16dad1102a6d0d9e56d5b67cb8dda7c8d20b51155c895f64ef +size 129424 diff --git a/website/docs/administration/context/document.png b/website/docs/administration/context/document.png new file mode 100644 index 000000000000..1f7c727c9d91 --- /dev/null +++ b/website/docs/administration/context/document.png @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:b8934f09b6094a2a6d4291e6189b2ead6080d045e203ff0f883fc465a1165b41 +size 152692 diff --git a/website/docs/administration/context/git.png b/website/docs/administration/context/git.png index 0588d3202c7b..a6fff23b7122 100644 --- a/website/docs/administration/context/git.png +++ b/website/docs/administration/context/git.png @@ -1,3 +1,3 @@ version https://git-lfs.github.com/spec/v1 -oid sha256:6dbb2eae9c0f8d39c887028ec8c341ed092229d2d9d22c179956fa1b9e460510 -size 50027 +oid sha256:3be9f784c3c4623e31ebc484167f201dfa8c9d799149e65cd4f349a7206c7c74 +size 51224 diff --git a/website/docs/administration/context/github-gitlab.png b/website/docs/administration/context/github-gitlab.png index 0701a54abc38..6b8f20910d07 100644 --- a/website/docs/administration/context/github-gitlab.png +++ b/website/docs/administration/context/github-gitlab.png @@ -1,3 +1,3 @@ version https://git-lfs.github.com/spec/v1 -oid sha256:7de324fa4c8c79085e573c93298e3279719b3d0e06b10971d5fe17f472c93d17 -size 118582 +oid sha256:b32ed29098bd1b32eb344171bbecdd16b64f2e11dee1d9fe91ba6408be6d1861 +size 96683 diff --git a/website/docs/administration/context/index.mdx b/website/docs/administration/context/index.mdx index 2ae82ee4e9e7..b30a799a072d 100644 --- a/website/docs/administration/context/index.mdx +++ b/website/docs/administration/context/index.mdx @@ -2,23 +2,35 @@ sidebar_position: 10 --- -import RepositoryProvidersUrl from "./repository-providers.png"; +import ContextProvidersUrl from "./context-providers.png"; import GitUrl from "./git.png"; import GitHubGitLabUrl from "./github-gitlab.png"; import SelectRepoUrl from "./select-repo.png"; +import CodeBrowserEntryUrl from "./code-browser-entry.png"; import CodeBrowserUrl from "./code-browser.png"; +import DocumentUrl from "./document.png"; import JobLinkUrl from "./repository-job.png"; import JobLogUrl from "./repository-job-run.png"; -# Repository Context +# Context Providers -The repository context is used to connect Tabby with a source code repository from Git, GitHub, GitLab, etc. Tabby fetches the source code from the repository, parses it into an AST, and stores it in the index. During LLM inference, this context is utilized for code completion, as well as chat and search functionalities. +Tabby Context supports two kinds of context currently: +1. source code repositories +2. developer docs + +The source code context is used to connect Tabby with a source code repository from Git, GitHub, GitLab, etc. +Tabby fetches the source code from the repository, parses it into an AST, and stores it in the index. During LLM inference, this context is utilized for code completion, as well as chat and search functionalities. + +The developer docs context is currently on Beta, +it is a critical source for engineering knowledge, +simply press the `@` button in the chat interface and select the document you wish to include, +Tabby will include these documents when interacting with LLMs. ## Adding a Repository through Admin UI -1. Navigate to the **Integrations > Repository Providers** page. +1. Navigate to the **Integrations > Context Providers** page. -Repository Providers +Context Providers 2. Click **Create** to begin the process of adding a repository provider. @@ -26,7 +38,7 @@ The repository context is used to connect Tabby with a source code repository fr Git - Local repositories are supported via the file:// protocol, but if running from a Docker container, you need to make it accessible with the [`--volume` flag](https://docs.docker.com/reference/cli/docker/container/run/#volume) and use the internal Docker path. + Local repositories are supported via the `file://` protocol, but if running from a Docker container, you need to make it accessible with the [`--volume` flag](https://docs.docker.com/reference/cli/docker/container/run/#volume) and use the internal Docker path. - For GitHub / GitLab, a personal access token is required to access private repositories. * Check the instructions in the corresponding tab to create a token. @@ -65,10 +77,24 @@ name = "repository_a" git_url = "file:///home/users/repository_a" ``` + +## Adding a Developer Doc through Admin UI + +1. Navigate to the **Integrations > Context Providers** page, and then select the `Developer Docs(Beta)`. + +Context Providers + +2. Turn on the switch to enable the integrated sites, or click the `+` button to add your own URLs + +Document + + ## Verifying the Repository Provider Once connected, the indexing job will start automatically. You can check the status of the indexing job on the **Information > Jobs** page. Additionally, you can also visit the **Code Browser** page to view the connected repository. -code browser' \ No newline at end of file +code browser entry + +code browser \ No newline at end of file diff --git a/website/docs/administration/context/repository-job-run.png b/website/docs/administration/context/repository-job-run.png index 6aa7b46ecfde..57d300644568 100644 --- a/website/docs/administration/context/repository-job-run.png +++ b/website/docs/administration/context/repository-job-run.png @@ -1,3 +1,3 @@ version https://git-lfs.github.com/spec/v1 -oid sha256:ae06b8bb8fe462effff129bb9612faf23df19b556fe0040506ea30d7769e9c17 -size 622264 +oid sha256:b3f875e5ea0cd6f106b5daf82588599fc2d1f4c8046e83334b1eac84e3ce7ef7 +size 349888 diff --git a/website/docs/administration/context/repository-job.png b/website/docs/administration/context/repository-job.png index eb110f9df449..1868a497b7c9 100644 --- a/website/docs/administration/context/repository-job.png +++ b/website/docs/administration/context/repository-job.png @@ -1,3 +1,3 @@ version https://git-lfs.github.com/spec/v1 -oid sha256:55d778d9d4f867984eb33ce6c2e7567c15ec43631b7a8294d074b3fe49b970f4 -size 36247 +oid sha256:884582c16dbc6d890099c8c66ef96b9203836920b63b3f1323fa947c4a219e81 +size 134958 diff --git a/website/docs/administration/context/repository-providers.png b/website/docs/administration/context/repository-providers.png deleted file mode 100644 index 04d7f2821f72..000000000000 --- a/website/docs/administration/context/repository-providers.png +++ /dev/null @@ -1,3 +0,0 @@ -version https://git-lfs.github.com/spec/v1 -oid sha256:4ffaa66d79b9f1f77bb2fcca68100c07ec03b177e56dc47567ee9fb6202dd149 -size 235241 diff --git a/website/docs/administration/context/select-repo.png b/website/docs/administration/context/select-repo.png index f0df76a4b870..6437a1922f9b 100644 --- a/website/docs/administration/context/select-repo.png +++ b/website/docs/administration/context/select-repo.png @@ -1,3 +1,3 @@ version https://git-lfs.github.com/spec/v1 -oid sha256:abd06a9fc34b0c73d897d1f3224c6cb36dbc81cfdf1eefe5edcaf2417d8c1705 -size 181629 +oid sha256:2a311148ec1665178cc4402c65eb9bb1b90059d98426c1fd9f18df31146d587f +size 129092 diff --git a/website/docs/administration/smtp/ses.png b/website/docs/administration/smtp/ses.png index f192e0b46324..00944ec9e0ac 100644 --- a/website/docs/administration/smtp/ses.png +++ b/website/docs/administration/smtp/ses.png @@ -1,3 +1,3 @@ version https://git-lfs.github.com/spec/v1 -oid sha256:aa9aa235b16ce80478b116e927557d4df16c8ad135241473d803a56070d37753 -size 360832 +oid sha256:e9843d334fba885d30db0832073ba8cc02efa720b6efda92c43697555197472c +size 403291 diff --git a/website/docs/administration/smtp/test-email.png b/website/docs/administration/smtp/test-email.png index 151c4cf72ba1..454e9016c574 100644 --- a/website/docs/administration/smtp/test-email.png +++ b/website/docs/administration/smtp/test-email.png @@ -1,3 +1,3 @@ version https://git-lfs.github.com/spec/v1 -oid sha256:6d70169af1a57a2b8dfe3824de7c70a87f92a81d1f5f7810168abca5ca062cf1 -size 29801 +oid sha256:c9113779ec1c3b64804a362763e85c51986d1eb552b5f579da2fb87126a3549a +size 46888 diff --git a/website/docs/administration/sso/integrations_sso.png b/website/docs/administration/sso/integrations_sso.png index c28ca3d52419..ebf39a984454 100644 --- a/website/docs/administration/sso/integrations_sso.png +++ b/website/docs/administration/sso/integrations_sso.png @@ -1,3 +1,3 @@ version https://git-lfs.github.com/spec/v1 -oid sha256:ae41718dc046a9bcbf2504b15200aba139edd92893a466d450a3fbac3379164f -size 200809 +oid sha256:aec0e0eb129d5b1f3c7358a5ea22dcd7d0d9ac4ebff8dcc100256b982671e5ed +size 102573 diff --git a/website/docs/administration/sso/sso_create.png b/website/docs/administration/sso/sso_create.png index 4a95f9f4de72..87192c53b33e 100644 --- a/website/docs/administration/sso/sso_create.png +++ b/website/docs/administration/sso/sso_create.png @@ -1,3 +1,3 @@ version https://git-lfs.github.com/spec/v1 -oid sha256:2b68ac87de0739fcdcddf173ebf47e437d55c84e6f5280511b31918308360c36 -size 166547 +oid sha256:c8ebdd4bc7dda4c73224ad3fb98c06ecfbec33ed2100b79c7c3044aa41703dee +size 171127 diff --git a/website/docs/administration/sso/sso_signin.png b/website/docs/administration/sso/sso_signin.png index d692a2a0c9bf..a1fbd70dc790 100644 --- a/website/docs/administration/sso/sso_signin.png +++ b/website/docs/administration/sso/sso_signin.png @@ -1,3 +1,3 @@ version https://git-lfs.github.com/spec/v1 -oid sha256:1b68539e4f1e96eea82e37cab8d02c1e9c78498293e99a348d4dc507c685105d -size 79842 +oid sha256:10e9adbf1e97719ca5c0bf38864d2599410285f84668f1e6b660ad5aa213cc51 +size 37308