diff options
Diffstat (limited to 'docs')
| -rw-r--r-- | docs/docs/concepts/autopilot.md | 6 | ||||
| -rw-r--r-- | docs/docs/concepts/core.md | 6 | ||||
| -rw-r--r-- | docs/docs/concepts/gui.md | 7 | ||||
| -rw-r--r-- | docs/docs/concepts/history.md | 6 | ||||
| -rw-r--r-- | docs/docs/concepts/ide.md | 34 | ||||
| -rw-r--r-- | docs/docs/concepts/llm.md | 16 | ||||
| -rw-r--r-- | docs/docs/concepts/policy.md | 6 | ||||
| -rw-r--r-- | docs/docs/concepts/recipe.md | 6 | ||||
| -rw-r--r-- | docs/docs/concepts/sdk.md | 32 | ||||
| -rw-r--r-- | docs/docs/concepts/step.md | 38 | ||||
| -rw-r--r-- | docs/docs/getting-started.md | 4 | ||||
| -rw-r--r-- | docs/docs/how-continue-works.md | 2 | ||||
| -rw-r--r-- | docs/docs/install.md | 2 | ||||
| -rw-r--r-- | docs/docs/walkthroughs/use-the-gui.md | 2 |
14 files changed, 85 insertions, 82 deletions
diff --git a/docs/docs/concepts/autopilot.md b/docs/docs/concepts/autopilot.md index 725e0d88..5073f7cb 100644 --- a/docs/docs/concepts/autopilot.md +++ b/docs/docs/concepts/autopilot.md @@ -1,10 +1,10 @@ # Autopilot
-## Overview
-
**TODO: Better explain in one sentence what this is and what its purpose is**
-The `autopilot` class is the main loop, completing steps and then deciding the next step and repeating
+:::info
+The **autopilot** is the main loop, completing steps and then deciding the next step and repeating
+:::
## Details
diff --git a/docs/docs/concepts/core.md b/docs/docs/concepts/core.md index b8cc1d50..766dbca0 100644 --- a/docs/docs/concepts/core.md +++ b/docs/docs/concepts/core.md @@ -1,10 +1,10 @@ # Core
-## Overview
-
**TODO: Better explain in one sentence what this is and what its purpose is**
-The `Continue Core` connects the [SDK](./sdk.md) and [GUI](./gui.md) with the [IDE](./ide.md) (i.e. in VS Code, GitHub Codespaces, a web browser text editor, etc), enabling the steps to make changes to your code and accelerate your software development workflows.
+:::info
+The **Continue Core** connects the [SDK](./sdk.md) and [GUI](./gui.md) with the [IDE](./ide.md) (i.e. in VS Code, GitHub Codespaces, a web browser text editor, etc), enabling the steps to make changes to your code and accelerate your software development workflows
+:::
## Details
diff --git a/docs/docs/concepts/gui.md b/docs/docs/concepts/gui.md index 4847572b..7ba16a63 100644 --- a/docs/docs/concepts/gui.md +++ b/docs/docs/concepts/gui.md @@ -2,11 +2,12 @@ **TODO: Make sure codebase aligns with this terminology**
-## Overview
-
**TODO: Explain in one sentence what this is and what its purpose is**
-The `Continue GUI` enables you to guide steps and makes everything transparent, so you can review all steps that were automated, giving you the opportunity to undo and rerun any that ran incorrectly.
+:::info
+The **Continue GUI** enables you to guide steps and makes everything transparent, so you can review all steps that were automated, giving you the opportunity to undo and rerun any that ran incorrectly
+:::
+
## Details
diff --git a/docs/docs/concepts/history.md b/docs/docs/concepts/history.md index 8b29b241..bf72d2b4 100644 --- a/docs/docs/concepts/history.md +++ b/docs/docs/concepts/history.md @@ -1,10 +1,10 @@ # History
-## Overview
-
**TODO: Better explain in one sentence what this is and what its purpose is**
-The `history` is the ordered record of all past steps.
+:::info
+The **history** is the ordered record of all past steps
+:::
## Details
diff --git a/docs/docs/concepts/ide.md b/docs/docs/concepts/ide.md index 56bece8e..f7ff2429 100644 --- a/docs/docs/concepts/ide.md +++ b/docs/docs/concepts/ide.md @@ -1,10 +1,10 @@ # IDE
-## Overview
-
**TODO: Better explain in one sentence what this is and what its purpose is**
-The `IDE` is the text editor where you manually edit your code.
+:::info
+The **IDE** is the text editor where you manually edit your code.
+:::
## Details
@@ -13,55 +13,55 @@ The `IDE` is the text editor where you manually edit your code. - `ide_protocol.py` is just the abstract version of what is implemented in `ide.py`, and `main.py` runs both `notebook.py` and `ide.py` as a single FastAPI server. This is the entry point to the Continue server, and acts as a bridge between IDE and React app
- extension directory contains 1. The VS Code extension, whose code is in `extension/src`, with `extension.ts` being the entry point, and 2. the Continue React app, in the `extension/react-app` folder. This is displayed in the sidebar of VSCode, but is designed to work with any IDE that implements the protocol as is done in `extension/src/continueIdeClient.ts`.
-### Supported IDEs
+## Supported IDEs
-#### VS Code
+### VS Code
You can install the VS Code extension [here](../install.md)
-#### GitHub Codespaces
+### GitHub Codespaces
You can install the GitHub Codespaces extension [here](../getting-started.md)
-### IDE Protocol methods
+## IDE Protocol methods
-#### handle_json
+### handle_json
Handle a json message
-#### showSuggestion
+### showSuggestion
Show a suggestion to the user
-#### getWorkspaceDirectory
+### getWorkspaceDirectory
Get the workspace directory
-#### setFileOpen
+### setFileOpen
Set whether a file is open
-#### openNotebook
+### openNotebook
Open a notebook
-#### showSuggestionsAndWait
+### showSuggestionsAndWait
Show suggestions to the user and wait for a response
-#### onAcceptRejectSuggestion
+### onAcceptRejectSuggestion
Called when the user accepts or rejects a suggestion
-#### onTraceback
+### onTraceback
Called when a traceback is received
-#### onFileSystemUpdate
+### onFileSystemUpdate
Called when a file system update is received
-#### onCloseNotebook
+### onCloseNotebook
Called when a notebook is closed
diff --git a/docs/docs/concepts/llm.md b/docs/docs/concepts/llm.md index d7d62b37..fb3b2a33 100644 --- a/docs/docs/concepts/llm.md +++ b/docs/docs/concepts/llm.md @@ -1,21 +1,23 @@ # LLM
-## Overview
-
**TODO: Better explain in one sentence what this is and what its purpose is**
-An `LLM` is short for Large Language Model, which includes models like GPT-4, StarCoder, and others.
+:::info
+An **LLM** is short for Large Language Model, which includes models like GPT-4, StarCoder, and others
+:::
## Details
**TODO: Nate to brain dump anything important to know and Ty to shape into paragraphs**
- `LLM` is the large language model that can be used in steps to automate that require some judgement based on context (e.g. generating code based on docs, explaining an error given a stack trace, etc)
+- Steps and recipes are implemented with specific models
+- Need to credentials for OpenAI models
-### Supported Models
+## Supported Models
-#### `gpt-4`
+### `gpt-4`
-#### `gpt-turbo-3.5`
+### `gpt-turbo-3.5`
-#### `StarCoder`
\ No newline at end of file +### `StarCoder`
\ No newline at end of file diff --git a/docs/docs/concepts/policy.md b/docs/docs/concepts/policy.md index 9658f6b4..79dbca56 100644 --- a/docs/docs/concepts/policy.md +++ b/docs/docs/concepts/policy.md @@ -1,10 +1,10 @@ # Policy
-## Overview
-
**TODO: Better explain in one sentence what this is and what its purpose is**
-A `policy` is decides what step to run next and is associated with a [autopilot](./autopilot.md).
+:::info
+A **policy** is decides what step to run next and is associated with a [autopilot](./autopilot.md)
+:::
## Details
diff --git a/docs/docs/concepts/recipe.md b/docs/docs/concepts/recipe.md index 3bc59b53..05d5eb0b 100644 --- a/docs/docs/concepts/recipe.md +++ b/docs/docs/concepts/recipe.md @@ -1,10 +1,10 @@ # Recipe
-## Overview
-
**TODO: Better explain in one sentence what this is and what its purpose is**
-A `recipe` is an ordered sequence of [steps](./step.md) that are intended to accomplish some complete task, comprising a workflow that developers use and share with others.
+:::info
+A **recipe** is an ordered sequence of [steps](./step.md) that are intended to accomplish some complete task, comprising a workflow that developers use and share with others.
+:::
## Details
diff --git a/docs/docs/concepts/sdk.md b/docs/docs/concepts/sdk.md index caf012ed..aab97f5f 100644 --- a/docs/docs/concepts/sdk.md +++ b/docs/docs/concepts/sdk.md @@ -1,10 +1,10 @@ # SDK
-## Overview
-
**TODO: Better explain in one sentence what this is and what its purpose is**
-The `Continue SDK` give you all the tools you need to automate software development tasks in one convenient and standard location (e.g. open a directory, edit a file, call an LLM, etc), which you can use when defining how a step should work and composing them with other steps.
+:::info
+The **Continue SDK** gives you all the tools you need to automate software development tasks in one convenient and standard location (e.g. open a directory, edit a file, call an LLM, etc), which you can use when defining how a step should work and composing them with other steps.
+:::
## Details
@@ -17,48 +17,48 @@ The `Continue SDK` give you all the tools you need to automate software developm - `sdk.llm` lets you use the Autopilot's language model like `sdk.llm.complete`
- `sdk.ide` lets you take any action within the connected IDE (this is where the IDE protocol is called)
-### Properties
+## Properties
-#### `sdk.ide`
+### `sdk.ide`
`sdk.ide` is an instance of the class `AbstractIdeProtocolServer`, which contains all the methods you might need to interact with the IDE. This includes things like reading, editing, saving, and opening files as well as getting the workspace directory, displaying suggestions, and more. The goal is to have an IDE agnostic way of interacting with IDEs, so that Steps are portable across VSCode, Sublime, Code, or any other editor you use.
-#### `sdk.models`
+### `sdk.models`
`sdk.models` is an instance of the `Models` class, containing many of the most commonly used LLMs or other foundation models. You can instantiate a model (starcoder for example) (this is too awkward rn, I know) by calling `starcoder = await sdk.models.starcoder()`. Right now, all of the models are `LLM`s, meaning that they offer the `complete` method, used like `bubble_sort_code = await starcoder.complete("# Write a bubble sort function below, in Python:\n")`.
-#### `sdk.history`
+### `sdk.history`
`sdk.history` is the `History` object that contains all information about previously run steps`. See the documentation page to learn more.
-### Methods
+## Methods
-#### `run_step`
+### `run_step`
`run_step` is what allows Steps to be composable. While at the core, steps are run by calling `step.run(continue_sdk)`, using `sdk.run_step(step)` automatically fills in the `ContinueSDK` parameter, takes care of recording the step in history, and automatically updates the GUI.
The below methods are all just shorthand for very common steps.
-#### `apply_filesystem_edit`
+### `apply_filesystem_edit`
`apply_filesystem_edit` takes a FileSystemEdit (subclasses include Add/DeleteFile/Directory and EditFile) and runs the `FileSystemEditStep`.
-#### `wait_for_user_input` and `wait_for_user_confirmation`
+### `wait_for_user_input` and `wait_for_user_confirmation`
`wait_for_user_input` and `wait_for_user_confirmation` both run steps that will open a cell prompting the user for some input, in the former case asking for a text input, and in the latter case just asking for confirmation through a button click. We are considering allowing for more complex forms in the future, potentially even dynamically generated by LLMs, so please reach out if this would be useful.
-#### `run`
+### `run`
`run` will run either a single command or a list of shell commands.
-#### `edit_file`
+### `edit_file`
`edit_file` takes a filename and prompt, then will use the EditCodeStep to apply the edits requested in natural language in the prompt to the file. The EditCodeStep uses StarCoder to do this; if you have reason to customize this functionality, you can define a custom step and call that.
-#### `add/delete_file/directory`
+### `add/delete_file/directory`
`add/delete_file/directory` do just that.
-#### `get_user_secret`
+### `get_user_secret`
-`get_user_secret` will retrieve a secret from the local .env file or, if it doesn't exist, prompt the user to enter the secret, then store this in the .env file.
+`get_user_secret` will retrieve a secret from the local .env file or, if it doesn't exist, prompt the user to enter the secret, then store this in the .env file.
\ No newline at end of file diff --git a/docs/docs/concepts/step.md b/docs/docs/concepts/step.md index fe044556..61761344 100644 --- a/docs/docs/concepts/step.md +++ b/docs/docs/concepts/step.md @@ -1,10 +1,10 @@ # Step
-## Overview
-
**TODO: Better explain in one sentence what this is and what its purpose is**
-A `step` is a simple action that the LLM should take as part of a sequence that collectively completes some task
+:::info
+A **step** is a simple action that the LLM should take as part of a sequence that collectively completes some task
+:::
## Details
@@ -18,54 +18,54 @@ A `step` is a simple action that the LLM should take as part of a sequence that - Any parameters to a Step are defined as attributes to the class without a double leading underscore (those with this are private).
- Steps can be composed together
-### Step methods
+## Step methods
-#### `run` (required)
+### `run` (required)
the code that should run when executed by the policy
-#### `description` (optional)
+### `description` (optional)
the definition of what the step does in natural language
-#### `reverse` (optional)
+### `reverse` (optional)
the code that should run when the step is reversed
-#### `modify` (optional)
+### `modify` (optional)
the code that should run when the step is rerun with feedback
**TODO: Move the below list / description of all steps and recipes to the place where people will be able to use, update, share them**
-### Steps & recipes
+## Steps & recipes
-#### Core
+### Core
-##### RunCommandStep
+#### RunCommandStep
-##### EditCodeStep
+#### EditCodeStep
-#### ManualEditStep
+### ManualEditStep
-### Community
+## Community
-#### CreateTableStep
+### CreateTableStep
Create a table in TypeORM
-#### MigrationStep
+### MigrationStep
Create and run an alembic migration
-##### Parameters
+#### Parameters
- `edited_file`:
-#### WritePytestsStep
+### WritePytestsStep
Write unit tests for this file.
-##### Parameters
+#### Parameters
- for_filepath (required): the path of the file that unit tests should be created for
\ No newline at end of file diff --git a/docs/docs/getting-started.md b/docs/docs/getting-started.md index bd77fe6e..bec9961c 100644 --- a/docs/docs/getting-started.md +++ b/docs/docs/getting-started.md @@ -6,7 +6,7 @@ 1. Click the `Open in GitHub Codespaces` badge above
-:::info
+:::tip
We don't want to waste your time with install and env setup before you try Continue, so we set up a GitHub Codespaces dev container for you, which **won’t cost you anything**. If you are using GitHub Free for personal accounts, you can [use Codespaces for 120 hours per month for free](https://docs.github.com/en/billing/managing-billing-for-github-codespaces/about-billing-for-github-codespaces#monthly-included-storage-and-core-hours-for-personal-accounts)
:::
@@ -27,7 +27,7 @@ c. In the third directory, try out Z recipe - something super simple (libaries)
- unit testing
-**TODO: Design and these recipes in codespaces**
+**TODO: Design and add these recipes in codespaces**
## Next Steps
diff --git a/docs/docs/how-continue-works.md b/docs/docs/how-continue-works.md index 751236fb..e032c7a4 100644 --- a/docs/docs/how-continue-works.md +++ b/docs/docs/how-continue-works.md @@ -14,7 +14,7 @@ The [GUI](./concepts/gui.md) enables you to guide steps and makes everything tra The [Core](./concepts/core.md) connects the SDK and GUI with the IDE (i.e. in VS Code, a web browser, etc), enabling the steps to make changes to your code and accelerate your software development workflows.
-## What to know about codebase
+## Details
**TODO: Refactor all of this and make it fit with language above**
diff --git a/docs/docs/install.md b/docs/docs/install.md index f44fb01e..b9916b73 100644 --- a/docs/docs/install.md +++ b/docs/docs/install.md @@ -16,7 +16,7 @@ If you want to try `Continue` before installing, check out the [GitHub Codespace ## How to install from source
-Please follow the [README instructions in the repo](https://github.com/continuedev/continue) to install `Continue` from source.
+Please follow the [README instructions in the repo](https://github.com/continuedev/continue/blob/main/README.md) to install `Continue` from source.
## Next steps
diff --git a/docs/docs/walkthroughs/use-the-gui.md b/docs/docs/walkthroughs/use-the-gui.md index 770b19d3..c244b461 100644 --- a/docs/docs/walkthroughs/use-the-gui.md +++ b/docs/docs/walkthroughs/use-the-gui.md @@ -5,8 +5,8 @@ Points to include
- Recipes
- Steps
-- Giving natural language instructions
- Single turn at the moment
- Opening the (set of) file(s) you want to edit
+- Then giving natural language instructions
- Reversing
- Modifying with feedback
\ No newline at end of file |