diff options
| author | Nate Sesti <sestinj@gmail.com> | 2023-06-02 19:45:17 -0400 |
|---|---|---|
| committer | Nate Sesti <sestinj@gmail.com> | 2023-06-02 19:45:17 -0400 |
| commit | bd7d3b8e524324a78667ca3eee01f9d7ae1181f3 (patch) | |
| tree | f481a49b63d89ef5d667dce0ec9a4b791786834e /docs/docs/how-continue-works.md | |
| parent | 57c3b77a5fe9ca73fb54d2c518470ef834aa9d72 (diff) | |
| parent | 8970af9e695fe8196f4f3b61dd16271ae733f630 (diff) | |
| download | sncontinue-bd7d3b8e524324a78667ca3eee01f9d7ae1181f3.tar.gz sncontinue-bd7d3b8e524324a78667ca3eee01f9d7ae1181f3.tar.bz2 sncontinue-bd7d3b8e524324a78667ca3eee01f9d7ae1181f3.zip | |
Merge branch 'docs'
Diffstat (limited to 'docs/docs/how-continue-works.md')
| -rw-r--r-- | docs/docs/how-continue-works.md | 10 |
1 files changed, 5 insertions, 5 deletions
diff --git a/docs/docs/how-continue-works.md b/docs/docs/how-continue-works.md index e6648cbc..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
@@ -19,7 +19,7 @@ The [Core](./concepts/core.md) holds the main event loop, responsible for connec - 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 GUIProtocol.
+ - 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.
- Communication between the extension and GUI happens through the Continue server.
- When you type a natural language command in the GUI, this is sent to the Continue server, where the `Autopilot` class takes action, potentially using the ContinueIdeProtocol to request actions be taken in the IDE, and then updates the GUI to display the new history.
- `core` directory contains major concepts
@@ -32,6 +32,6 @@ The [Core](./concepts/core.md) holds the main event loop, responsible for connec - `util` for very misc. stuff
- `chroma` for chroma code that deals with codebase embeddings
- `models` contains all the Pydantic models and `generate_json_schema.py`, a script that converts them to JSONSchema .json files in `schema/json`
-- `server` runs the servers that communicate with a) the React app (`gui.py`) and b) the IDE (`ide.py`)
-- `ide_protocol.py` is just the abstract version of what is implemented in `ide.py`, and `main.py` runs both `gui.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
+- `server` runs the servers that communicate with a) the React app (`notebook.py`) and b) the IDE (`ide.py`)
+- `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
- We use OpenAPI/JSONSchema to define types so that it's really easy to bring them across language barriers. Use Pydantic types, then run `poetry run typegen` from the root of continuedev folder to generate JSONSchema json files in the `schema/json` folder. Then `npm run typegen` from the extension folder generates the types that are used within the extension.
|
