diff options
| author | Ty Dunn <ty@tydunn.com> | 2023-09-12 17:01:48 -0700 |
|---|---|---|
| committer | Ty Dunn <ty@tydunn.com> | 2023-09-12 17:01:48 -0700 |
| commit | 7204b7246b9aa360876d4782839a68d5fd9dd6c7 (patch) | |
| tree | 93828df0ee49578911cb6cb918701816f63b677c | |
| parent | 6a29b1086b438b7a08844ec240955403dfb5abc6 (diff) | |
| download | sncontinue-7204b7246b9aa360876d4782839a68d5fd9dd6c7.tar.gz sncontinue-7204b7246b9aa360876d4782839a68d5fd9dd6c7.tar.bz2 sncontinue-7204b7246b9aa360876d4782839a68d5fd9dd6c7.zip | |
updating how continue works
| -rw-r--r-- | docs/docs/how-continue-works.md | 33 | ||||
| -rw-r--r-- | docs/static/img/continue-architecture.png | bin | 1023648 -> 0 bytes | |||
| -rw-r--r-- | docs/static/img/continue-diagram.png | bin | 0 -> 61307 bytes |
3 files changed, 28 insertions, 5 deletions
diff --git a/docs/docs/how-continue-works.md b/docs/docs/how-continue-works.md index 07d16474..ce670a88 100644 --- a/docs/docs/how-continue-works.md +++ b/docs/docs/how-continue-works.md @@ -1,14 +1,37 @@ # ⚙️ How Continue works
-
+
-The `Continue` library consists of an **SDK**, a **GUI**, and a **Server** that brings everything together.
+## Overview
-1. The **SDK** 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.
+- Continue is typically used inside of an Integrated Development Environment (IDE) like VS Code or JetBrains
+- All units of action in Continue are called steps. Steps can be recursively composed into more complex steps
+- Steps have access to the SDK, which enables you to use LLMs in your workflows (e.g. edit a file, call a model, etc)
+- The Server facilitates communication between the IDE and the GUI and determines what steps to take next
+- The GUI enables you to review every automated step, giving you the opportunity to undo and rerun any or all
+- It is also possible to run Continue in headless, asynchronous mode. Please reach out if you are interested in this!
-2. The **GUI** lets you transparently review every automated step, providing the opportunity to undo and rerun any that ran incorrectly.
+## Supported IDEs
-3. The **Server** is responsible for connecting the GUI and SDK to the IDE as well as deciding which steps to take next.
+### VS Code (Beta)
+
+Continue can be used as a VS Code extension.
+
+You can install it from the Visual Studio Marketplace [here](https://marketplace.visualstudio.com/items?itemName=Continue.continue).
+
+### JetBrains (Alpha)
+
+Continue can be used as a plugin inside of PyCharm, Intellij, WebStorm, etc.
+
+You can install it from the JetBrains Marketplace [here](https://continue.dev/).
+
+### Add Continue to a new IDE
+
+Here is how you can get started with adding Continue to a new IDE:
+
+1. Let us know that you would like to add Continue to a new IDE by opening an issue [here](https://github.com/continuedev/continue/issues/new/choose)
+2. Implement a class that maps each of the actions like "read file" to the API provided by that IDE like [here](https://github.com/continuedev/continue/blob/main/extension/src/continueIdeClient.ts)
+3. Learn more about what you might also do by looking at this pull request that added initial support for JetBrains [here](https://github.com/continuedev/continue/pull/457)
## Running the server manually
diff --git a/docs/static/img/continue-architecture.png b/docs/static/img/continue-architecture.png Binary files differdeleted file mode 100644 index 58366d8f..00000000 --- a/docs/static/img/continue-architecture.png +++ /dev/null diff --git a/docs/static/img/continue-diagram.png b/docs/static/img/continue-diagram.png Binary files differnew file mode 100644 index 00000000..aac9b8be --- /dev/null +++ b/docs/static/img/continue-diagram.png |
