diff options
Diffstat (limited to 'docs')
| -rw-r--r-- | docs/docs/how-continue-works.md | 14 | ||||
| -rw-r--r-- | docs/static/img/continue-architecture.png | bin | 0 -> 136666 bytes |
2 files changed, 9 insertions, 5 deletions
diff --git a/docs/docs/how-continue-works.md b/docs/docs/how-continue-works.md index 550f328b..7868c6be 100644 --- a/docs/docs/how-continue-works.md +++ b/docs/docs/how-continue-works.md @@ -1,6 +1,10 @@ # How `Continue` works
-*TODO: Describe in more detail how `Continue` works*
+_TODO: Describe in more detail how `Continue` works_
+
+> (Nate) 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 (maybe I'll draw a diagram): 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. 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.
+
+
## Overview
@@ -15,9 +19,9 @@ The [Core](./concepts/core.md) connects the SDK and GUI with the IDE (i.e. in VS ## What to know about codebase
- `core` directory contains major concepts
- - This includes Autopilot, Policy, SDK (all in their own files so far)
- - It also includes `main.py`, which contains History, HistoryNode, Step, and others
- - You'll find `env.py` here too, which is a common place to load environment variables, which can then be imported from here
+ - This includes Autopilot, Policy, SDK (all in their own files so far)
+ - It also includes `main.py`, which contains History, HistoryNode, Step, and others
+ - You'll find `env.py` here too, which is a common place to load environment variables, which can then be imported from here
- `libs` contains misc. stuff
- `llm` for language model utilities
- `steps` for builtin Continue steps
@@ -26,4 +30,4 @@ The [Core](./concepts/core.md) connects the SDK and GUI with the IDE (i.e. in VS - `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 (`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.
\ No newline at end of file +- 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.
diff --git a/docs/static/img/continue-architecture.png b/docs/static/img/continue-architecture.png Binary files differnew file mode 100644 index 00000000..7a38c904 --- /dev/null +++ b/docs/static/img/continue-architecture.png |
