443 lines
13 KiB
Plaintext
443 lines
13 KiB
Plaintext
---
|
|
title: "@Docs (Deprecated)"
|
|
description: Deprecated documentation context provider - use the new documentation awareness approach instead
|
|
keywords: [deprecated, documentation, docs, context, embeddings, legacy]
|
|
noindex: true
|
|
---
|
|
|
|
<Warning>
|
|
**This feature is deprecated.** The `@Docs` context provider has been deprecated in favor of a more integrated approach to documentation awareness. Please refer to our [Guide on Making Agent Mode Aware of Codebases and Documentation](/guides/codebase-documentation-awareness) for the recommended approach.
|
|
</Warning>
|
|
|
|
## Migration Guide
|
|
|
|
If you're currently using the `@Docs` context provider, please migrate to the new approach outlined in our [codebase and documentation awareness guide](/guides/codebase-documentation-awareness). The new approach provides:
|
|
|
|
- Better integration with Continue's Agent mode features
|
|
- More intelligent context selection
|
|
- Improved performance and accuracy
|
|
|
|
## Legacy Documentation
|
|
|
|
**Below is the original documentation for the `@Docs` context provider, preserved for reference**
|
|
|
|
The `@Docs` context provider allows you to efficiently reference documentation directly within Continue.
|
|
|
|
## How to Enable the @Docs Context Provider
|
|
|
|
To enable the `@Docs` context provider, add it to the list of context providers in your `config.json` file.
|
|
|
|
<Tabs>
|
|
<Tab title="YAML">
|
|
```yaml title="config.yaml"
|
|
name: My Config
|
|
version: 0.0.1
|
|
schema: v1
|
|
|
|
context:
|
|
- provider: docs
|
|
```
|
|
</Tab>
|
|
<Tab title="JSON">
|
|
```json title="config.json"
|
|
{
|
|
"contextProviders": [
|
|
{
|
|
"name": "docs"
|
|
}
|
|
]
|
|
}
|
|
```
|
|
</Tab>
|
|
</Tabs>
|
|
|
|
## How the @Docs Context Provider Works
|
|
|
|
The `@Docs` context provider works by
|
|
|
|
1. Crawling specified documentation sites
|
|
2. Generating embeddings for the chunked content
|
|
3. Storing the embeddings locally on your machine
|
|
4. Embedding chat input to include similar documentation chunks as context
|
|
|
|
## How to Index Your Own Documentation
|
|
|
|
**Note:** Documentation configuration should now be done directly in your `config.yaml` file. The previous `docs` blocks functionality has been deprecated.
|
|
|
|
### How to Add Documentation Through the @Docs Context Provider
|
|
|
|
To add a single documentation site, we recommend using the **Add Documentation** Form within the GUI. This can be accessed
|
|
|
|
- from the `@Docs` context provider - type `@Docs` in the chat, hit `Enter`, and search for `Add Docs`
|
|
- from the `More` page (three dots icon) in the `@docs indexes` section
|
|
the `@Docs` context provider.
|
|
|
|
In the **Add Documentation** Form, enter a `Title` and `Start URL` for the site.
|
|
|
|
- `Title`: The name of the documentation site, used for identification in the UI.
|
|
- `Start URL`: The URL where the indexing process should begin.
|
|
|
|
Indexing will begin upon submission. Progress can be viewed in the form or later in the `@docs indexes` section of the `More` page.
|
|
|
|
Documentation sources may be suggested based on package files in your repo. This currently works for Python `requirements.txt` files and Node.js (Javascript/Typescript) `package.json` files.
|
|
|
|
- Packages with a valid documentation URL (with a `+` icon) can be clicked to immediately kick off indexing
|
|
- Packages with partial information (with a pen icon) can be clicked to fill the form with the available information
|
|
- Note that you can hover over the information icon to see where the package suggestion was found.
|
|
|
|
|
|
|
|
### How to Add Documentation in Configuration Files
|
|
|
|
For bulk documentation site adds or edits, we recommend editing your global configuration file directly. Documentation sites are stored in an array within `docs` in your global configuration, as follows:
|
|
|
|
<Tabs>
|
|
<Tab title="YAML">
|
|
```yaml title="config.yaml"
|
|
name: My Config
|
|
version: 0.0.1
|
|
schema: v1
|
|
|
|
docs:
|
|
- title: Nest.js
|
|
startUrl: https://docs.nestjs.com/
|
|
faviconUrl: https://docs.nestjs.com/favicon.ico
|
|
```
|
|
</Tab>
|
|
<Tab title="JSON">
|
|
```json title="config.json"
|
|
{
|
|
"docs": [
|
|
{
|
|
"title": "Nest.js",
|
|
"startUrl": "https://docs.nestjs.com/",
|
|
"faviconUrl": "https://docs.nestjs.com/favicon.ico"
|
|
}
|
|
]
|
|
}
|
|
```
|
|
</Tab>
|
|
</Tabs>
|
|
|
|
See [the config reference](/reference) for all documentation site configuration options.
|
|
|
|
Indexing will re-sync upon saving the configuration file.
|
|
|
|
## How to Configure @Docs Advanced Settings
|
|
|
|
### How to Use Your Custom Embeddings Provider
|
|
|
|
If you have set up an [embeddings provider](../customize/model-roles/embeddings.mdx), @docs will use your embeddings provider. Switching embeddings providers will trigger a re-index of all documentation sites in your configuration.
|
|
|
|
### How to Configure Reranking for Better Results
|
|
|
|
As with [@Codebase context provider configuration](./deprecated-codebase#configuration), you can adjust the reranking behavior of the `@Docs` context provider with the `nRetrieve`, `nFinal`, and `useReranking`.
|
|
|
|
<Tabs>
|
|
<Tab title="YAML">
|
|
```yaml title="config.yaml"
|
|
name: My Config
|
|
version: 0.0.1
|
|
schema: v1
|
|
|
|
context:
|
|
- provider: docs
|
|
params:
|
|
nRetrieve: 25 # The number of docs to retrieve from the embeddings query
|
|
nFinal: 5 # The number of docs chunks to return IF reranking
|
|
useReranking: true # use reranking if a reranker is configured (defaults to true)
|
|
```
|
|
</Tab>
|
|
<Tab title="JSON">
|
|
```json title="config.json"
|
|
{
|
|
"contextProviders": [
|
|
{
|
|
"name": "docs",
|
|
"params": {
|
|
"nRetrieve": 25, // The number of docs to retrieve from the embeddings query
|
|
"nFinal": 5, // The number of docs chunks to return IF reranking
|
|
"useReranking": true // use reranking if a reranker is configured (defaults to true)
|
|
}
|
|
}
|
|
]
|
|
}
|
|
```
|
|
</Tab>
|
|
</Tabs>
|
|
|
|
### How to Set Up GitHub Token for GitHub Documentation
|
|
|
|
The GitHub API rate limits public requests to 60 per hour. If you want to reliably index GitHub repos, you can add a github token to your config file:
|
|
|
|
<Tabs>
|
|
<Tab title="YAML">
|
|
```yaml title="config.yaml"
|
|
name: My Config
|
|
version: 0.0.1
|
|
schema: v1
|
|
|
|
context:
|
|
- provider: docs
|
|
params:
|
|
githubToken: <GITHUB_TOKEN>
|
|
```
|
|
</Tab>
|
|
<Tab title="JSON">
|
|
```json title="config.json"
|
|
{
|
|
"contextProviders": [
|
|
{
|
|
"name": "docs",
|
|
"params": {
|
|
"githubToken": "github_..."
|
|
}
|
|
}
|
|
]
|
|
}
|
|
```
|
|
</Tab>
|
|
</Tabs>
|
|
|
|
### How to Enable Local Crawling for Private Documentation
|
|
|
|
By default, Continue crawls documentation sites using a specialized crawling service that provides the best experience for most users and documentation sites.
|
|
|
|
If your documentation is private, you can skip the default crawler and use a local crawler instead by setting `useLocalCrawling` to `true`.
|
|
|
|
<Tabs>
|
|
<Tab title="YAML">
|
|
```yaml title="config.yaml"
|
|
name: My Config
|
|
version: 0.0.1
|
|
schema: v1
|
|
|
|
docs:
|
|
- title: My Private Docs
|
|
startUrl: http://10.2.1.2/docs
|
|
faviconUrl: http://10.2.1.2/docs/assets/favicon.ico,
|
|
useLocalCrawling: true
|
|
```
|
|
</Tab>
|
|
<Tab title="JSON">
|
|
```json title="config.json"
|
|
{
|
|
"docs": [
|
|
{
|
|
"title": "My Private Docs",
|
|
"startUrl": "http://10.2.1.2/docs",
|
|
"faviconUrl": "http://10.2.1.2/docs/assets/favicon.ico",
|
|
"useLocalCrawling": true
|
|
}
|
|
]
|
|
}
|
|
```
|
|
</Tab>
|
|
</Tabs>
|
|
|
|
<Info>
|
|
The default local crawler is a lightweight tool that cannot render sites that
|
|
are dynamically generated using JavaScript. If your sites need to be rendered,
|
|
you can enable the experimental `Use Chromium for Docs Crawling` feature from
|
|
your User Settings Page. This will download and install Chromium
|
|
to `~/.continue/.utils`, and use it as the local crawler. **Note:** Chromium
|
|
crawling support is being deprecated and may be removed in future versions.
|
|
</Info>
|
|
|
|
Further notes:
|
|
|
|
- If the site is only locally accessible, the default crawler will fail anyways and fall back to the local crawler. `useLocalCrawling` is especially useful if the URL itself is confidential.
|
|
- For GitHub Repos this has no effect because only the GitHub Crawler will be used, and if the repo is private it can only be accessed with a priveleged GitHub token anyways.
|
|
|
|
## How to Manage Your Documentation Indexes
|
|
|
|
You can view indexing statuses and manage your documentation sites from the `@docs indexes` section of the `More` page (three dots)
|
|
|
|
- Continue does not automatically re-index your docs. Use `Click to re-index` to trigger a reindex for a specific source
|
|
- While a site is indexing, click `Cancel indexing` to cancel the process
|
|
- Failed indexing attempts will show an error status bar and icon
|
|
- Delete a documentation site from your configuration using the trash icon
|
|
|
|
|
|
|
|
You can also view the overall status of currently indexing docs from a hideable progress bar at the bottom of the chat page
|
|
|
|
|
|
|
|
You can also use the following IDE command to force a re-index of all docs: `Continue: Docs Force Re-Index`.
|
|
|
|
## Configuration Examples for Different Setups
|
|
|
|
### How to Set Up @Docs in VS Code (Minimal Configuration)
|
|
|
|
The following configuration example works out of the box for VS Code. This uses the built-in embeddings provider with no reranking.
|
|
|
|
<Tabs>
|
|
<Tab title="YAML">
|
|
```yaml title="config.yaml"
|
|
name: My Config
|
|
version: 0.0.1
|
|
schema: v1
|
|
|
|
context:
|
|
- provider: docs
|
|
|
|
docs:
|
|
- title: Nest.js
|
|
startUrl: https://docs.nestjs.com/
|
|
```
|
|
</Tab>
|
|
<Tab title="JSON">
|
|
```json title="config.json"
|
|
{
|
|
"contextProviders": [
|
|
{
|
|
"name": "docs",
|
|
}
|
|
],
|
|
"docs": [
|
|
{
|
|
"title": "Nest.js",
|
|
"startUrl": "https://docs.nestjs.com/",
|
|
},
|
|
]
|
|
}
|
|
```
|
|
</Tab>
|
|
</Tabs>
|
|
|
|
### How to Set Up @Docs in JetBrains IDEs (Minimal Configuration)
|
|
|
|
Here is the equivalent minimal example for Jetbrains, which requires setting up an [embeddings provider](../customize/model-roles/embeddings.mdx).
|
|
|
|
<Tabs>
|
|
<Tab title="YAML">
|
|
```yaml title="config.yaml"
|
|
name: My Config
|
|
version: 0.0.1
|
|
schema: v1
|
|
|
|
models:
|
|
- name: LMStudio embedder
|
|
provider: lmstudio
|
|
model: nomic-ai/nomic-embed-text-v1.5-GGUF
|
|
roles:
|
|
- embed
|
|
context:
|
|
- provider: docs
|
|
docs:
|
|
- title: Nest.js
|
|
startUrl: https://docs.nestjs.com/
|
|
```
|
|
</Tab>
|
|
<Tab title="JSON">
|
|
```json title="config.json"
|
|
{
|
|
"contextProviders": [
|
|
{
|
|
"name": "docs",
|
|
}
|
|
],
|
|
"docs": [
|
|
{
|
|
"title": "Nest.js",
|
|
"startUrl": "https://docs.nestjs.com/",
|
|
},
|
|
],
|
|
"embeddingsProvider": {
|
|
"provider": "lmstudio",
|
|
"model": "nomic-ai/nomic-embed-text-v1.5-GGUF"
|
|
}
|
|
}
|
|
```
|
|
</Tab>
|
|
</Tabs>
|
|
|
|
### How to Set Up @Docs with Advanced Features (VS Code or JetBrains)
|
|
|
|
The following configuration example includes:
|
|
|
|
- Examples of both public and private documentation sources
|
|
- A custom embeddings provider
|
|
- A reranker model available, with reranking parameters customized
|
|
- A GitHub token to enable GitHub crawling
|
|
|
|
<Tabs>
|
|
<Tab title="YAML">
|
|
```yaml title="config.yaml"
|
|
name: My Config
|
|
version: 0.0.1
|
|
schema: v1
|
|
|
|
models:
|
|
- name: LMStudio Nomic Text
|
|
provider: lmstudio
|
|
model: nomic-ai/nomic-embed-text-v1.5-GGUF
|
|
roles:
|
|
- embed
|
|
- name: Voyage Rerank-2
|
|
provider: voyage
|
|
apiKey: <VOYAGE_API_KEY>
|
|
model: rerank-2
|
|
roles:
|
|
- rerank
|
|
context:
|
|
- provider: docs
|
|
params:
|
|
githubToken: <GITHUB_TOKEN>
|
|
nRetrieve: 25
|
|
nFinal: 5
|
|
useReranking: true
|
|
docs:
|
|
- title: Nest.js
|
|
startUrl: https://docs.nestjs.com/
|
|
- title: My Private Docs
|
|
startUrl: http://10.2.1.2/docs
|
|
faviconUrl: http://10.2.1.2/docs/assets/favicon.ico
|
|
useLocalCrawling: true
|
|
```
|
|
</Tab>
|
|
<Tab title="JSON">
|
|
```json title="config.json"
|
|
{
|
|
"contextProviders": [
|
|
{
|
|
"name": "docs",
|
|
"params": {
|
|
"githubToken": "github_...",
|
|
"nRetrieve": 25,
|
|
"nFinal": 5,
|
|
"useReranking": true
|
|
}
|
|
}
|
|
],
|
|
"docs": [
|
|
{
|
|
"title": "Nest.js",
|
|
"startUrl": "https://docs.nestjs.com/"
|
|
},
|
|
{
|
|
"title": "My Private Docs",
|
|
"startUrl": "http://10.2.1.2/docs",
|
|
"faviconUrl": "http://10.2.1.2/docs/assets/favicon.ico",
|
|
"maxDepth": 4,
|
|
"useLocalCrawling": true
|
|
}
|
|
],
|
|
"reranker": {
|
|
"name": "voyage",
|
|
"params": {
|
|
"model": "rerank-2",
|
|
"apiKey": "<YOUR_VOYAGE_API_KEY>"
|
|
}
|
|
},
|
|
"embeddingsProvider": {
|
|
"provider": "lmstudio",
|
|
"model": "nomic-ai/nomic-embed-text-v1.5-GGUF"
|
|
}
|
|
}
|
|
```
|
|
</Tab>
|
|
</Tabs>
|
|
|
|
This setup could also involve enabling Chromium as a backup for local documentation through the User Settings Page (Gear Icon). |