From 84fc39407648131d54a8ed5c95891906afc3cd60 Mon Sep 17 00:00:00 2001 From: Nate Sesti Date: Tue, 12 Sep 2023 01:07:54 -0700 Subject: docs: :memo: complete docs for context providers --- docs/docs/reference/Context Providers/diff.md | 10 ++++------ docs/docs/reference/Context Providers/file.md | 5 +++-- docs/docs/reference/Context Providers/filetree.md | 10 ++++------ docs/docs/reference/Context Providers/github.md | 8 ++++---- docs/docs/reference/Context Providers/google.md | 10 ++++------ docs/docs/reference/Context Providers/search.md | 10 ++++------ docs/docs/reference/Context Providers/terminal.md | 10 ++++------ docs/docs/reference/Context Providers/url.md | 10 ++++------ docs/docs/reference/config.md | 2 +- 9 files changed, 32 insertions(+), 43 deletions(-) (limited to 'docs') diff --git a/docs/docs/reference/Context Providers/diff.md b/docs/docs/reference/Context Providers/diff.md index a0aaedcf..00d63d58 100644 --- a/docs/docs/reference/Context Providers/diff.md +++ b/docs/docs/reference/Context Providers/diff.md @@ -2,16 +2,14 @@ import ClassPropertyRef from '@site/src/components/ClassPropertyRef.tsx'; # DiffContextProvider -The ContextProvider class is a plugin that lets you provide new information to the LLM by typing '@'. -When you type '@', the context provider will be asked to populate a list of options. -These options will be updated on each keystroke. -When you hit enter on an option, the context provider will add that item to the autopilot's list of context (which is all stored in the ContextManager object). +Type '@diff' to reference all of the changes you've made to your current branch. This is useful if you want to summarize what you've done or ask for a general review of your work before committing. -[View the source](https://github.com/continuedev/continue/tree/main/continuedev/src/continuedev/libs/llm/diff.py) +[View the source](https://github.com/continuedev/continue/tree/main/continuedev/src/continuedev/plugins/context_providers/diff.py) ## Properties - + ### Inherited Properties + \ No newline at end of file diff --git a/docs/docs/reference/Context Providers/file.md b/docs/docs/reference/Context Providers/file.md index d1ef0761..d29625a9 100644 --- a/docs/docs/reference/Context Providers/file.md +++ b/docs/docs/reference/Context Providers/file.md @@ -4,11 +4,12 @@ import ClassPropertyRef from '@site/src/components/ClassPropertyRef.tsx'; The FileContextProvider is a ContextProvider that allows you to search files in the open workspace. -[View the source](https://github.com/continuedev/continue/tree/main/continuedev/src/continuedev/libs/llm/file.py) +[View the source](https://github.com/continuedev/continue/tree/main/continuedev/src/continuedev/plugins/context_providers/file.py) ## Properties - + ### Inherited Properties + \ No newline at end of file diff --git a/docs/docs/reference/Context Providers/filetree.md b/docs/docs/reference/Context Providers/filetree.md index 07c39630..94492d3d 100644 --- a/docs/docs/reference/Context Providers/filetree.md +++ b/docs/docs/reference/Context Providers/filetree.md @@ -2,16 +2,14 @@ import ClassPropertyRef from '@site/src/components/ClassPropertyRef.tsx'; # FileTreeContextProvider -The ContextProvider class is a plugin that lets you provide new information to the LLM by typing '@'. -When you type '@', the context provider will be asked to populate a list of options. -These options will be updated on each keystroke. -When you hit enter on an option, the context provider will add that item to the autopilot's list of context (which is all stored in the ContextManager object). +Type '@tree' to reference the contents of your current workspace. The LLM will be able to see the nested directory structure of your project. -[View the source](https://github.com/continuedev/continue/tree/main/continuedev/src/continuedev/libs/llm/filetree.py) +[View the source](https://github.com/continuedev/continue/tree/main/continuedev/src/continuedev/plugins/context_providers/filetree.py) ## Properties - + ### Inherited Properties + \ No newline at end of file diff --git a/docs/docs/reference/Context Providers/github.md b/docs/docs/reference/Context Providers/github.md index 45482957..21171ced 100644 --- a/docs/docs/reference/Context Providers/github.md +++ b/docs/docs/reference/Context Providers/github.md @@ -2,14 +2,14 @@ import ClassPropertyRef from '@site/src/components/ClassPropertyRef.tsx'; # GitHubIssuesContextProvider -The GitHubIssuesContextProvider is a ContextProvider -that allows you to search GitHub issues in a repo. +The GitHubIssuesContextProvider is a ContextProvider that allows you to search GitHub issues in a repo. Type '@issue' to reference the title and contents of an issue. -[View the source](https://github.com/continuedev/continue/tree/main/continuedev/src/continuedev/libs/llm/github.py) +[View the source](https://github.com/continuedev/continue/tree/main/continuedev/src/continuedev/plugins/context_providers/github.py) ## Properties - + ### Inherited Properties + \ No newline at end of file diff --git a/docs/docs/reference/Context Providers/google.md b/docs/docs/reference/Context Providers/google.md index 6538802e..d8452ab0 100644 --- a/docs/docs/reference/Context Providers/google.md +++ b/docs/docs/reference/Context Providers/google.md @@ -2,16 +2,14 @@ import ClassPropertyRef from '@site/src/components/ClassPropertyRef.tsx'; # GoogleContextProvider -The ContextProvider class is a plugin that lets you provide new information to the LLM by typing '@'. -When you type '@', the context provider will be asked to populate a list of options. -These options will be updated on each keystroke. -When you hit enter on an option, the context provider will add that item to the autopilot's list of context (which is all stored in the ContextManager object). +Type '@google' to reference the results of a Google search. For example, type "@google python tutorial" if you want to search and discuss ways of learning Python. -[View the source](https://github.com/continuedev/continue/tree/main/continuedev/src/continuedev/libs/llm/google.py) +[View the source](https://github.com/continuedev/continue/tree/main/continuedev/src/continuedev/plugins/context_providers/google.py) ## Properties - + ### Inherited Properties + \ No newline at end of file diff --git a/docs/docs/reference/Context Providers/search.md b/docs/docs/reference/Context Providers/search.md index 5276daa2..5d80f607 100644 --- a/docs/docs/reference/Context Providers/search.md +++ b/docs/docs/reference/Context Providers/search.md @@ -2,16 +2,14 @@ import ClassPropertyRef from '@site/src/components/ClassPropertyRef.tsx'; # SearchContextProvider -The ContextProvider class is a plugin that lets you provide new information to the LLM by typing '@'. -When you type '@', the context provider will be asked to populate a list of options. -These options will be updated on each keystroke. -When you hit enter on an option, the context provider will add that item to the autopilot's list of context (which is all stored in the ContextManager object). +Type '@search' to reference the results of codebase search, just like the results you would get from VS Code search. -[View the source](https://github.com/continuedev/continue/tree/main/continuedev/src/continuedev/libs/llm/search.py) +[View the source](https://github.com/continuedev/continue/tree/main/continuedev/src/continuedev/plugins/context_providers/search.py) ## Properties - + ### Inherited Properties + \ No newline at end of file diff --git a/docs/docs/reference/Context Providers/terminal.md b/docs/docs/reference/Context Providers/terminal.md index 37c70ab4..dce6f0a4 100644 --- a/docs/docs/reference/Context Providers/terminal.md +++ b/docs/docs/reference/Context Providers/terminal.md @@ -2,16 +2,14 @@ import ClassPropertyRef from '@site/src/components/ClassPropertyRef.tsx'; # TerminalContextProvider -The ContextProvider class is a plugin that lets you provide new information to the LLM by typing '@'. -When you type '@', the context provider will be asked to populate a list of options. -These options will be updated on each keystroke. -When you hit enter on an option, the context provider will add that item to the autopilot's list of context (which is all stored in the ContextManager object). +Type '@terminal' to reference the contents of your IDE's terminal. -[View the source](https://github.com/continuedev/continue/tree/main/continuedev/src/continuedev/libs/llm/terminal.py) +[View the source](https://github.com/continuedev/continue/tree/main/continuedev/src/continuedev/plugins/context_providers/terminal.py) ## Properties - + ### Inherited Properties + \ No newline at end of file diff --git a/docs/docs/reference/Context Providers/url.md b/docs/docs/reference/Context Providers/url.md index b0cfac07..3917dc38 100644 --- a/docs/docs/reference/Context Providers/url.md +++ b/docs/docs/reference/Context Providers/url.md @@ -2,16 +2,14 @@ import ClassPropertyRef from '@site/src/components/ClassPropertyRef.tsx'; # URLContextProvider -The ContextProvider class is a plugin that lets you provide new information to the LLM by typing '@'. -When you type '@', the context provider will be asked to populate a list of options. -These options will be updated on each keystroke. -When you hit enter on an option, the context provider will add that item to the autopilot's list of context (which is all stored in the ContextManager object). +Type '@url' to reference the contents of a URL. You can either reference preset URLs, or reference one dynamically by typing '@url https://example.com'. The text contents of the page will be fetched and used as context. -[View the source](https://github.com/continuedev/continue/tree/main/continuedev/src/continuedev/libs/llm/url.py) +[View the source](https://github.com/continuedev/continue/tree/main/continuedev/src/continuedev/plugins/context_providers/url.py) ## Properties - + ### Inherited Properties + \ No newline at end of file diff --git a/docs/docs/reference/config.md b/docs/docs/reference/config.md index dbcfc4c6..27612924 100644 --- a/docs/docs/reference/config.md +++ b/docs/docs/reference/config.md @@ -4,7 +4,7 @@ import ClassPropertyRef from '@site/src/components/ClassPropertyRef.tsx'; Continue can be deeply customized by editing the `ContinueConfig` object in `~/.continue/config.py` (`%userprofile%\.continue\config.py` for Windows) on your machine. This class is instantiated from the config file for every new session. -[View the source](https://github.com/continuedev/continue/tree/main/continuedev/src/continuedev/libs/llm/config.py) +[View the source](https://github.com/continuedev/continue/tree/main/continuedev/src/continuedev/core/config.py) ## Properties -- cgit v1.2.3-70-g09d2