Skip to main content
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 for the recommended approach.

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. 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.
config.yaml
name: My Config
version: 0.0.1
schema: v1

context:
  - provider: docs

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.