diff options
Diffstat (limited to 'docs/docs')
-rw-r--r-- | docs/docs/how-continue-works.md | 27 | ||||
-rw-r--r-- | docs/docs/install.md | 2 | ||||
-rw-r--r-- | docs/docs/telemetry.md | 2 |
3 files changed, 6 insertions, 25 deletions
diff --git a/docs/docs/how-continue-works.md b/docs/docs/how-continue-works.md index 809bcd32..436f7506 100644 --- a/docs/docs/how-continue-works.md +++ b/docs/docs/how-continue-works.md @@ -6,31 +6,10 @@ 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.
-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.
+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 and workflows.
2. The [GUI](./concepts/gui.md) lets you transparently review every automated step, providing the opportunity to undo and rerun any that ran incorrectly.
-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.
+3. The [Server](./concepts/server.md) holds the main event loop, responsible for connecting the IDE, SDK, and GUI together as well as deciding which steps to take next.
-## Details
-
-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.
-
-- 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.
- - 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
- - 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
-- `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 (`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 +Continue connects any IDE (Integrated Development Environment) (e.g. VS Code, GitHub Codespaces, PyCharm, Replit, etc.) to the Continue Server, which take actions in the code editor as instructed by recipes that are run by a user through the GUI.
\ No newline at end of file diff --git a/docs/docs/install.md b/docs/docs/install.md index dfb8236e..4c3efb07 100644 --- a/docs/docs/install.md +++ b/docs/docs/install.md @@ -12,6 +12,8 @@ If you want to try Continue before installing locally, check out the [GitHub Cod 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:
+**TODO: Add link to screenshot of what it looks like after install has completed**
+
![vs-code-install]()
:::note
diff --git a/docs/docs/telemetry.md b/docs/docs/telemetry.md index c5e938dd..e22d89e8 100644 --- a/docs/docs/telemetry.md +++ b/docs/docs/telemetry.md @@ -18,4 +18,4 @@ Create a `continue.json` file in the root of your workspace and add the followin {
"allow_anonymous_telemetry": false
}
-```
+```
\ No newline at end of file |