summaryrefslogtreecommitdiff
path: root/extension
diff options
context:
space:
mode:
Diffstat (limited to 'extension')
-rw-r--r--extension/DEV_README.md7
-rw-r--r--extension/examples/README.md3
-rw-r--r--extension/react-app/README.md3
-rw-r--r--extension/schema/README.md3
4 files changed, 16 insertions, 0 deletions
diff --git a/extension/DEV_README.md b/extension/DEV_README.md
new file mode 100644
index 00000000..7049da45
--- /dev/null
+++ b/extension/DEV_README.md
@@ -0,0 +1,7 @@
+# Continue VS Code Extension
+
+This is the Continue VS Code Extension. Its primary jobs are
+
+1. Implement the IDE side of the Continue IDE protocol, allowing a Continue server to interact natively in an IDE. This happens in `src/continueIdeClient.ts`.
+2. Open the Continue React app in a side panel. The React app's source code lives in the `react-app` directory. The panel is opened by the `continue.openDebugPanel` command, as defined in `src/commands.ts`.
+3. Run a Continue server in the background, which connects to both the IDE protocol and the React app. The server is launched in `src/activation/environmentSetup.ts` by calling Python code that lives in `scripts/` (unless extension settings define a server URL other than localhost:8000, in which case the extension will just connect to that).
diff --git a/extension/examples/README.md b/extension/examples/README.md
new file mode 100644
index 00000000..c95b9220
--- /dev/null
+++ b/extension/examples/README.md
@@ -0,0 +1,3 @@
+# Examples
+
+This folder contains example code used in Continue demos.
diff --git a/extension/react-app/README.md b/extension/react-app/README.md
new file mode 100644
index 00000000..006b6b11
--- /dev/null
+++ b/extension/react-app/README.md
@@ -0,0 +1,3 @@
+# Continue React App
+
+The Continue React app is a notebook-like interface to the Continue server. It allows the user to submit arbitrary text input, then communicates with the server to takes steps, which are displayed as a sequence of editable cells. The React app should sit beside an IDE, as in the VS Code extension.
diff --git a/extension/schema/README.md b/extension/schema/README.md
new file mode 100644
index 00000000..9c97c0eb
--- /dev/null
+++ b/extension/schema/README.md
@@ -0,0 +1,3 @@
+# Schema
+
+These are files autogenerated by `npm run typegen`. They come originally from the `continuedev` Python package's Pydantic types.