Skip to content

Commit

Permalink
docs: update smtp / context / sso docs to fit 0.17 (#3193)
Browse files Browse the repository at this point in the history
* chore: update admin docs to fit 0.17

* chore: always use developer docs
  • Loading branch information
zwpaper authored Sep 24, 2024
1 parent 194d7e2 commit 80f34f9
Show file tree
Hide file tree
Showing 16 changed files with 64 additions and 32 deletions.
3 changes: 3 additions & 0 deletions website/docs/administration/context/code-browser-entry.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
4 changes: 2 additions & 2 deletions website/docs/administration/context/code-browser.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
3 changes: 3 additions & 0 deletions website/docs/administration/context/context-providers.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
3 changes: 3 additions & 0 deletions website/docs/administration/context/document.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
4 changes: 2 additions & 2 deletions website/docs/administration/context/git.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
4 changes: 2 additions & 2 deletions website/docs/administration/context/github-gitlab.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
40 changes: 33 additions & 7 deletions website/docs/administration/context/index.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -2,31 +2,43 @@
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.

<img src={RepositoryProvidersUrl} alt="Repository Providers" />
<img src={ContextProvidersUrl} alt="Context Providers" />

2. Click **Create** to begin the process of adding a repository provider.

- For Git, you only need to fill in the name and the URL of the repository.

<img src={GitUrl} alt="Git" width="700" />

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.
Expand Down Expand Up @@ -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)`.

<img src={ContextProvidersUrl} alt="Context Providers" />

2. Turn on the switch to enable the integrated sites, or click the `+` button to add your own URLs

<img src={DocumentUrl} alt="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.

<img src={CodeBrowserUrl} alt="code browser" width="800" />'
<img src={CodeBrowserEntryUrl} alt="code browser entry" width="300" />

<img src={CodeBrowserUrl} alt="code browser" width="800" />
4 changes: 2 additions & 2 deletions website/docs/administration/context/repository-job-run.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
4 changes: 2 additions & 2 deletions website/docs/administration/context/repository-job.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
3 changes: 0 additions & 3 deletions website/docs/administration/context/repository-providers.png

This file was deleted.

4 changes: 2 additions & 2 deletions website/docs/administration/context/select-repo.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
4 changes: 2 additions & 2 deletions website/docs/administration/smtp/ses.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
4 changes: 2 additions & 2 deletions website/docs/administration/smtp/test-email.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
4 changes: 2 additions & 2 deletions website/docs/administration/sso/integrations_sso.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
4 changes: 2 additions & 2 deletions website/docs/administration/sso/sso_create.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
4 changes: 2 additions & 2 deletions website/docs/administration/sso/sso_signin.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.

0 comments on commit 80f34f9

Please sign in to comment.