diff options
| -rw-r--r-- | docs/docs/concepts/server.md (renamed from docs/docs/concepts/core.md) | 8 | ||||
| -rw-r--r-- | docs/docs/concepts/step.md | 2 | ||||
| -rw-r--r-- | docs/docs/getting-started.md | 12 | ||||
| -rw-r--r-- | docs/docs/how-continue-works.md | 4 | ||||
| -rw-r--r-- | docs/docs/install.md | 9 | ||||
| -rw-r--r-- | docs/docs/intro.md | 2 | ||||
| -rw-r--r-- | docs/sidebars.js | 2 |
7 files changed, 16 insertions, 23 deletions
diff --git a/docs/docs/concepts/core.md b/docs/docs/concepts/server.md index e9757b36..3eebdb5f 100644 --- a/docs/docs/concepts/core.md +++ b/docs/docs/concepts/server.md @@ -1,18 +1,18 @@ -# Core
+# Server
**TODO: Better explain in one sentence what this is and what its purpose is**
:::info
-The **Continue Core** holds the main event loop, responsible for connecting [IDE](./ide.md) (i.e. in VS Code, GitHub Codespaces, a web browser text editor, etc), [SDK](./sdk.md), and [GUI](./gui.md), and deciding which steps to take next.
+The **Continue Server** holds the main event loop, responsible for connecting [IDE](./ide.md) (i.e. in VS Code, GitHub Codespaces, a web browser text editor, etc), [SDK](./sdk.md), and [GUI](./gui.md), and deciding which steps to take next.
:::
## Details
I tried a rewrite of the info box above. The core doesn't really mean that much except for maybe the Autopilot class and the small set of classes in core.py, including History, Step, Policy mostly. Maybe best referred to as a set of abstractions. Autopilot runs the main event loop, basically queueing user input and asking the policy what to do next, and injecting the SDK, and recording history. I suppose you could also say it includes the protocols, in which case you might say "connects IDE and GUI through the SDK", though lots of 3-letter acronyms going on here. Notes below are correct.
-- The `Core` includes
+- The `server` includes
- IDE protocol
- GUI protocol
- SDK
- Autopilot
-- There is a two-way sync between an IDE and the GUI that happens through Core
+- There is a two-way sync between an IDE and the GUI that happens through the server
diff --git a/docs/docs/concepts/step.md b/docs/docs/concepts/step.md index b92e6faf..1758fdd8 100644 --- a/docs/docs/concepts/step.md +++ b/docs/docs/concepts/step.md @@ -66,4 +66,4 @@ Write unit tests for this file. #### Parameters
-- for_filepath (required): the path of the file that unit tests should be created for
+- 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 39becd1a..90d6f8dc 100644 --- a/docs/docs/getting-started.md +++ b/docs/docs/getting-started.md @@ -14,18 +14,14 @@ We don't want to waste your time with install and env setup before you try Conti **TODO: Insert an image of Continue when it has opened**
-3. Try playing with Continue as you build a Python script to do Pandas stuff
+3. Try playing with Continue as you write some Python code to understand a dataset with Pandas
**TODO: Design and set up Pandas stuff scenario in codespaces**
4. There are a few recipes you should also try
- a. In the first directory, try out X recipe
- b. In the second directory, try out Y recipe
- c. In the third directory, try out Z recipe
-
-- database migrations
-- something super simple (libaries)
-- unit testing
+ a. In the first directory, try out Pytest recipe
+ b. In the second directory, try out Write comments for the highlighted code recipe
+ c. In the third directory, try out dlt CreatePipeline recipe
**TODO: Design and add these recipes in codespaces**
diff --git a/docs/docs/how-continue-works.md b/docs/docs/how-continue-works.md index 32bf6347..2d5f09a8 100644 --- a/docs/docs/how-continue-works.md +++ b/docs/docs/how-continue-works.md @@ -4,13 +4,13 @@ ## Overview
-The `Continue` library consists of an [SDK](./concepts/sdk.md), a [GUI](./concepts/gui.md), and a [Core](./concepts/core.md) that brings everything together.
+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.
The [GUI](./concepts/gui.md) lets you transparently review every automated step, providing the opportunity to undo and rerun any that ran incorrectly.
-The [Core](./concepts/core.md) holds the main event loop, responsible for connecting IDE, SDK, and GUI and deciding which steps to take next.
+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
diff --git a/docs/docs/install.md b/docs/docs/install.md index 6dce5da4..7e36ffd5 100644 --- a/docs/docs/install.md +++ b/docs/docs/install.md @@ -4,7 +4,7 @@ If you want to try `Continue` before installing, check out the [GitHub Codespaces Demo](./getting-started.md)
:::
-## Install `Continue` packaged as a VS Code extension
+## Install `Continue` locally in VS Code
1. Click `Install` on the `Continue` extension in the Visual Studio Marketplace [here](https://marketplace.visualstudio.com/items?itemName=Continue.continue)
@@ -20,11 +20,8 @@ Please follow the [README instructions in the repo](https://github.com/continued ## Next steps
-Now that you have installed the VS Code extension, you can learn more with our walkthroughs:
-
-How to...
-
+Now that you have installed locally in VS Code, you can learn more with our walkthroughs:
- [Use the GUI](./walkthroughs/use-the-gui.md)
-- [Invoke a recipe](./walkthroughs/use-a-recipe.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)
diff --git a/docs/docs/intro.md b/docs/docs/intro.md index 5d73a256..b1ce4c72 100644 --- a/docs/docs/intro.md +++ b/docs/docs/intro.md @@ -15,6 +15,6 @@ You define the scenarios where Large Language Models ([LLMs](./concepts/llm.md)) ## Why do developers use `Continue`? -Many developers have begun to use models like [GPT-4](https://openai.com/research/gpt-4) through [ChatGPT](https://openai.com/blog/chatgpt) while coding; however, the experience is painful because of how much manual copying, pasting, and editing is required to supply them with context and transfer the generated solutions to your codebase. `Continue` eliminates this pain by deeply integrating LLMs into your IDE. +Many developers have begun to use models like [GPT-4](https://openai.com/research/gpt-4) through [ChatGPT](https://openai.com/blog/chatgpt) while coding; however, the experience is painful because of how much manual copying, pasting, and editing is required to supply them with context and transfer the generated solutions to your codebase. `Continue` eliminates this pain by deeply integrating LLMs into your IDE amd workflows. `Continue` accelerates how developers build, ship, and maintain software, while giving them the control to define when LLMs should take actions and the confidence to trust LLMs. In short, it enables developers to do what they have always done: work together to create better and better abstractions that make it easier and easier to automate the repetitive work that people want computers to do. diff --git a/docs/sidebars.js b/docs/sidebars.js index e232ceeb..b3ebec57 100644 --- a/docs/sidebars.js +++ b/docs/sidebars.js @@ -33,7 +33,7 @@ const sidebars = { label: "Concepts", items: [ "concepts/autopilot", - "concepts/core", + "concepts/server", "concepts/gui", "concepts/history", "concepts/ide", |