Skip to content

Commit bb695f3

Browse files
docs(context): add notes for developer documentation (#4254)
* docs(context): add notes for developer documentation * [autofix.ci] apply automated fixes --------- Co-authored-by: autofix-ci[bot] <114827586+autofix-ci[bot]@users.noreply.github.com>
1 parent 6ef4c1a commit bb695f3

File tree

2 files changed

+14
-2
lines changed
  • ee/tabby-ui/app/(dashboard)/settings/(integrations)/providers/doc
  • website/docs/administration/context

2 files changed

+14
-2
lines changed

ee/tabby-ui/app/(dashboard)/settings/(integrations)/providers/doc/page.tsx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,7 @@ export default function DocumentProviderPage() {
88
return (
99
<>
1010
<CardContent className="pl-0">
11-
<SubHeader>
11+
<SubHeader externalLink="https://tabby.tabbyml.com/docs/administration/context/#adding-a-developer-doc-through-admin-ui">
1212
<p>
1313
Documents are a critical source for engineering knowledge. Tabby
1414
provides an easy way to include these documents when interacting

website/docs/administration/context/index.mdx

Lines changed: 13 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -79,6 +79,13 @@ git_url = "file:///home/users/repository_a"
7979

8080
## Adding a Developer Doc through Admin UI
8181

82+
:::info[Note]
83+
84+
1. By default, Tabby uses the **[Katana](https://github.com/projectdiscovery/katana)** to crawl developer documentation. For **Docker deployments**, Katana is pre-installed in the container image. **Non-Docker deployments** require manual Katana installation.
85+
2. If a developer documentation site implements the **[llms.txt](https://llmstxt.org/)** standard, Tabby directly retrieves and indexes the specified documents, instead of using Katana for automated crawling.
86+
87+
:::
88+
8289
1. Navigate to the **Integrations > Context Providers** page, and then select the `Developer Docs(Beta)`.
8390

8491
<img src={ContextProvidersUrl} alt="Context Providers" />
@@ -96,4 +103,9 @@ Additionally, you can also visit the **Code Browser** page to view the connected
96103

97104
<img src={CodeBrowserEntryUrl} alt="code browser entry" width="300" />
98105

99-
<img src={CodeBrowserUrl} alt="code browser" width="800" />
106+
<img src={CodeBrowserUrl} alt="code browser" width="800" />
107+
108+
109+
110+
111+

0 commit comments

Comments
 (0)