diff options
| -rw-r--r-- | docs/docs/how-continue-works.md | 9 | ||||
| -rw-r--r-- | docs/docs/install.md | 12 | ||||
| -rw-r--r-- | extension/README.md | 26 |
3 files changed, 12 insertions, 35 deletions
diff --git a/docs/docs/how-continue-works.md b/docs/docs/how-continue-works.md index 905bb344..809bcd32 100644 --- a/docs/docs/how-continue-works.md +++ b/docs/docs/how-continue-works.md @@ -6,17 +6,16 @@ The `Continue` library consists of an [SDK](./concepts/sdk.md), a [GUI](./concepts/gui.md), and a [Server](./concepts/server.md) that brings everything together.
-The [SDK](./concepts/sdk.md) gives you access to the tools (e.g. open a directory, edit a file, call a model, etc.) needed to define steps that integrate LLMs into your IDE.
+1. The [SDK](./concepts/sdk.md) gives you access to the tools (e.g. open a directory, edit a file, call a model, etc.) needed to define steps that integrate LLMs into your IDE.
-The [GUI](./concepts/gui.md) lets you transparently review every automated step, providing the opportunity to undo and rerun any that ran incorrectly.
+2. The [GUI](./concepts/gui.md) lets you transparently review every automated step, providing the opportunity to undo and rerun any that ran incorrectly.
-The [Server](./concepts/server.md) holds the main event loop, responsible for connecting IDE, SDK, and GUI and deciding which steps to take next.
+3. The [Server](./concepts/server.md) holds the main event loop, responsible for connecting IDE, SDK, and GUI and deciding which steps to take next.
## Details
-**TODO: Refactor all of this and make it fit with language above**
+Continue connects any code editor (e.g. VS Code, GitHub Codespaces, PyCharm, Replit, etc.) to the Continue Server, which take actions in the editor as instructed by recipes that a run by a user through the GUI.
-- Continue connects any code editor (primarily VS Code right now) to a server (the Continue server) that can take actions in the editor in accordance with defined recipes at the request of a user through the GUI
- What this looks like:
- The Continue VS Code extension runs the ContinueIdeProtocol, launches the Continue Python server in the background, and opens the Continue GUI in a side-panel.
- The Continue server is the brain, communication center, and source of truth, interacting with VS Code through the ContinueIdeProtocol and with the GUI through the NotebookProtocol.
diff --git a/docs/docs/install.md b/docs/docs/install.md index a19b2e8c..dfb8236e 100644 --- a/docs/docs/install.md +++ b/docs/docs/install.md @@ -10,13 +10,13 @@ If you want to try Continue before installing locally, check out the [GitHub Cod 2. This will open the Continue extension page in VS Code, where you will need to click `Install` again
-3. Once you do this, you will see a message in the bottom right hand corner of VS Code that says `Setting up Continue extension...`. After a couple minutes, the Continue extension will then open up. It should look like this when it is complete:
+3. Once you do this, you will see a message in the bottom right hand corner of VS Code that says `Setting up Continue extension...`. After 30-90 seconds, the Continue extension will then open up. It should look like this when it is complete:
+![vs-code-install]()
-
-## How to install from source
-
-Please follow the [README instructions in the repo](https://github.com/continuedev/continue/blob/main/README.md) to install Continue from source.
+:::note
+If you would like to install Continue from source, please [follow the instructions](https://github.com/continuedev/continue/blob/main/README.md) in the repo README.
+:::
## Next steps
@@ -24,4 +24,4 @@ Now that you have installed locally in VS Code, you can learn more with our walk - [Use the GUI](./walkthroughs/use-the-gui.md)
- [Use a recipe](./walkthroughs/use-a-recipe.md)
- [Create a recipe](./walkthroughs/create-a-recipe.md)
-- [Share a recipe](./walkthroughs/share-a-recipe.md)
+- [Share a recipe](./walkthroughs/share-a-recipe.md)
\ No newline at end of file diff --git a/extension/README.md b/extension/README.md index 51e95822..9ee59ad3 100644 --- a/extension/README.md +++ b/extension/README.md @@ -1,27 +1,5 @@ # Continue -Automate software development at the level of tasks, instead of tab-autocompletions. With Continue, you can make large edits with natural language, ask questions of your codebase, and run custom recipes built with our open-source Python library. +**[Continue](https://continue.dev/docs) is the open-source library for accelerating software development with language models** -Get started by opening the command pallet with `cmd+shift+p` and then selecting `Continue: Open Debug Panel`. - -# Features - -### Ask a Question - -Ask natural language questions of your codebase, like "Where is the entry point to the VS Code extension?" - -### Edit with Natural Language - -Request an edit to the currently open file, for example: "Add CORS headers to this FastAPI server". - -### Generate a Fix - -Once Continue has code snippets to work with, it can generate a fix. Just click to accept or reject, or make the tweak you need. - -### Stacktrace Parsing - -Any stacktrace that appears in your VS Code terminal will be caught by us so we can immediately begin the debugging process. For small bugs that you might have quickly solved, we'll just speed up the process to be nearly instantaneous. - -### Generate Unit Tests and Docstrings - -Use `cmd+shift+i` to generate a unit test for the function surrounding your cursor position, and `cmd+shift+l` to generate a docstring. +You can find the Continue GitHub repo [here](https://github.com/continuedev/continue)
\ No newline at end of file |