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.
- YAML
- JSON
config.yaml
How the @Docs Context Provider Works
The@Docs context provider works by
- Crawling specified documentation sites
- Generating embeddings for the chunked content
- Storing the embeddings locally on your machine
- 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 yourconfig.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
@Docscontext provider - type@Docsin the chat, hitEnter, and search forAdd Docs - from the
Morepage (three dots icon) in the@docs indexessection the@Docscontext provider.
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.
@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.