Merge pull request #58 from continuedev/optimize-docs

optimizing initial docs

11 files changed, 95 insertions, 117 deletions

diff --git a/README.md b/README.md
index 98eef4ca..e721c768 100644
--- a/README.md
+++ b/README.md
@@ -1,49 +1,76 @@
-![GitHub issues](https://img.shields.io/github/issues-raw/continuedev/continue)
+<h1 align="center"> Continue </h1>
+
+<div align="center">
+
+**[Continue](https://continue.dev/docs) is the open-source library for accelerating software development with language models**
+
+</div>
+
+<div align="center">
+
 [![License](https://img.shields.io/badge/License-Apache_2.0-blue.svg)](https://opensource.org/licenses/Apache-2.0)
+![GitHub issues](https://img.shields.io/github/issues-raw/continuedev/continue)
 ![GitHub Repo stars](https://img.shields.io/github/stars/continuedev/continue?style=social)
 ![Twitter URL](https://img.shields.io/twitter/url?style=social&url=https%3A%2F%2Fgithub.com%2Fcontinuedev%2Fcontinue)
 
-# Continue
+</div>
 
-Continue is the open-source autopilot for software developers. Using our SDK you can write short scripts, called recipes, that automate sequences of tasks that are common within your codebase. This repository contains:
+## Getting Started
 
-- The Continue Python package, which offers an SDK to write recipes and the Continue server, which runs all automations
-- The Continue VSCode extension, where you can natively run recipes and use natural language to refine code much faster
+### GitHub Codespaces
 
-**[Read the docs](https://continuedev.netlify.app/)**
+Learn how to try the GitHub Codespaces Demo [here](https://continue.dev/docs/getting-started)
 
-# Getting Started
+### VS Code
 
-The easiest way to start using Continue is to download our VS Code extension from the marketplace:
+Learn how to install locally in VS Code [here](https://continue.dev/docs/install)
 
-[Download for VS Code](https://marketplace.visualstudio.com/items?itemName=Continue.continue)
+## Walkthroughs
 
-Alternatively, you can build from source. Just clone the repo and run a Python script:
+- [Use the GUI](https://continue.dev/walkthroughs/use-the-gui.md)
+- [Use a recipe](https://continue.dev/walkthroughs/use-a-recipe.md)
+- [Create a recipe](https://continue.dev/walkthroughs/create-a-recipe.md)
+- [Share a recipe](https://continue.dev/walkthroughs/share-a-recipe.md)
 
-```bash
-git clone https://github.com/continuedev/continue && cd continue/extension/scripts && python3 install_from_source.py
-```
+## How to contribute
 
-# Writing Recipes
+### Option 1: Create a recipe and share it with the community
 
-Check out the [recipes folder](https://github.com/continuedev/continue/tree/main/continuedev/src/continuedev/recipes) to learn how to write your own.
+Follow [these steps](https://continue.dev/walkthroughs/share-a-recipe.md) to share a recipe you have created :)
 
-# Contributing
+### Option 2: Open a [new GitHub Issue](https://github.com/continuedev/continue/issues/new) or comment on [an existing one](https://github.com/continuedev/continue/issues)
 
-Please do! The easiest way to start contributing is by writing recipes, but PRs/suggestions of all kinds are welcome : )
+Let us know what you would like to contribute and we will help you make it happen!
 
-# Subfolder READMEs
+## Install from source
 
-[PyPI Package (Continue Server)](./continuedev) - See here to learn about the Continue Server, which can be downloaded as a [PyPI package](https://pypi.org/project/continuedev/).
+#### 1. Clone this repo
 
-[Continue VS Code Extension](./extension) - See here to learn about the capabilities of our VS Code extension, which is the first implementation of Continue's IDE Protocol, built to be editor-agnostic. A README for developers is found in the [`src/` folder.](./extension/src).
+Reccommended: Run this command to use SSH
+```bash
+git clone git@github.com:continuedev/continue.git
+```
+
+Alternative: Run this command to use HTTPS
+```bash
+git clone https://github.com/continuedev/continue
+```
+
+#### 2. Install Continue
 
-[Continue GUI](./extension/react-app/) - The Continue GUI is a React app that lets users interact with the server. It is made to be placed adjacent to the text editor in your IDE.
+Run this command to use the install script
+```bash
+cd continue/extension/scripts && python3 install_from_source.py
+```
 
-[Docs](./docs) - The source for our documentation.
+# Understanding the codebase
 
-[Schema](./schema) - JSON Schema types generated from Pydantic models, used across the `continuedev` and `extension/` directories.
+- [Continue Server README](./continuedev): learn about the core of Continue, which can be downloaded as a [PyPI package](https://pypi.org/project/continuedev/)
+- [VS Code Extension README](./extension/src): learn about the capabilities of our extension—the first implementation of Continue's IDE Protocol—which makes it possible to use use Continue in VS Code and GitHub Codespaces
+- [Continue GUI README](./extension/react-app/): learn about the React app that lets users interact with the server and is placed adjacent to the text editor in any suppported IDE
+- [Schema README](./schema): learn about the JSON Schema types generated from Pydantic models, which we use across the `continuedev/` and `extension/` directories
+- [Continue Docs README](./docs): learn how our [docs](https://continue.dev/docs) are written and built
 
 # License
 
-[Apache-2.0](<[https://github.com/sestinj/the-x/blob/main/LICENSE](https://opensource.org/licenses/Apache-2.0)>) © 2023 Continue
+[Apache 2.0 © 2023 Continue Dev, Inc.](./LICENSE)
\ No newline at end of file
diff --git a/docs/docs/concepts/continue-json.md b/docs/docs/concepts/continue-json.md
new file mode 100644
index 00000000..7227f660
--- /dev/null
+++ b/docs/docs/concepts/continue-json.md
@@ -0,0 +1,3 @@
+# continue.json

+

+**TODO: Need to explain this**
\ No newline at end of file
diff --git a/docs/docs/getting-started.md b/docs/docs/getting-started.md
index 90d6f8dc..2ffa7227 100644
--- a/docs/docs/getting-started.md
+++ b/docs/docs/getting-started.md
@@ -10,30 +10,18 @@
 We don't want to waste your time with install and env setup before you try Continue, so we set up a GitHub Codespace for you, which **won’t cost you anything**. If you are using GitHub Free for personal accounts, you can [use Codespaces for 120 hours per month for free](https://docs.github.com/en/billing/managing-billing-for-github-codespaces/about-billing-for-github-codespaces#monthly-included-storage-and-core-hours-for-personal-accounts)

 :::

 

-2. Select the `Create new codespace` button and wait a couple minutes while it launches and installs the Continue extension. Once complete, it should look like this:

+2. Select the `Create new codespace` button and wait 30-90 seconds while it launches and installs the Continue extension. Once complete, it should look like this:

 

-**TODO: Insert an image of Continue when it has opened**

+**TODO: Adding image of Codespaces once its ready to be used**

 

-3. Try playing with Continue as you write some Python code to understand a dataset with Pandas

-

-**TODO: Design and set up Pandas stuff scenario in codespaces**

-

-4. There are a few recipes you should also try

-   a. In the first directory, try out Pytest recipe

-   b. In the second directory, try out Write comments for the highlighted code recipe

-   c. In the third directory, try out dlt CreatePipeline recipe

-

-**TODO: Design and add these recipes in codespaces**

+3. Read the `Getting Started` section of the `README.md` file that has been opened in your codespace, which you can also find [here](https://github.com/continuedev/continue-codespaces-demo/blob/main/README.md)

 

 ## Next Steps

 

-If you're ready to use Continue locally, install `Continue` packaged as a VS Code extension, as described [here](./install.md).

+If you would like to use Continue locally, you can follow [these steps](./install.md) to install it in VS Code.

 

 If you'd like to continue exploring in GitHub Codespaces, you can learn more with our walkthroughs:

-

-How to...

-

 - [Use the GUI](./walkthroughs/use-the-gui.md)

-- [Invoke a recipe](./walkthroughs/use-a-recipe.md)

+- [Use a recipe](./walkthroughs/use-a-recipe.md)

 - [Create a recipe](./walkthroughs/create-a-recipe.md)

-- [Share a recipe](./walkthroughs/share-a-recipe.md)

+- [Share a recipe](./walkthroughs/share-a-recipe.md)
\ No newline at end of file
diff --git a/docs/docs/how-continue-works.md b/docs/docs/how-continue-works.md
index 2d5f09a8..436f7506 100644
--- a/docs/docs/how-continue-works.md
+++ b/docs/docs/how-continue-works.md
@@ -6,32 +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.

 

-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.

 

-The [GUI](./concepts/gui.md) lets you transparently review every automated step, providing the opportunity to undo and rerun any that ran incorrectly.

+2. The [GUI](./concepts/gui.md) lets you transparently review every automated step, providing the opportunity to undo and rerun any that ran incorrectly.

 

-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

-

-**TODO: Refactor all of this and make it fit with language above**

-

-- 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 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.

+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 7e36ffd5..4c75bc4a 100644
--- a/docs/docs/install.md
+++ b/docs/docs/install.md
@@ -1,22 +1,22 @@
 # Installation

 

 :::note

-If you want to try `Continue` before installing, check out the [GitHub Codespaces Demo](./getting-started.md)

+If you want to try Continue before installing locally, check out the [GitHub Codespaces Demo](./getting-started.md)

 :::

 

-## Install `Continue` locally in VS Code

+## Install Continue locally in VS Code

 

-1. Click `Install` on the `Continue` extension in the Visual Studio Marketplace [here](https://marketplace.visualstudio.com/items?itemName=Continue.continue)

+1. Click `Install` on the Continue extension in the Visual Studio Marketplace [here](https://marketplace.visualstudio.com/items?itemName=Continue.continue)

 

-2. This will open the `Continue` extension page in VS Code, where you will need to click `Install` again

+2. This will open the Continue extension page in VS Code, where you will need to click `Install` again

 

-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 a couple minutes, the `Continue` extension will then open up

+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: Finish writing out this step-by-step**

+**TODO: Add link to screenshot of what it looks like after install has completed**

 

-## How to install from source

-

-Please follow the [README instructions in the repo](https://github.com/continuedev/continue/blob/main/README.md) to install `Continue` from source.

+:::note

+If you would like to install Continue from source, please [follow the instructions](https://github.com/continuedev/continue/blob/main/README.md) in the repo README.

+:::

 

 ## Next steps

 

@@ -24,4 +24,4 @@ Now that you have installed locally in VS Code, you can learn more with our walk
 - [Use the GUI](./walkthroughs/use-the-gui.md)

 - [Use a recipe](./walkthroughs/use-a-recipe.md)

 - [Create a recipe](./walkthroughs/create-a-recipe.md)

-- [Share a recipe](./walkthroughs/share-a-recipe.md)

+- [Share a recipe](./walkthroughs/share-a-recipe.md)
\ No newline at end of file
diff --git a/docs/docs/intro.md b/docs/docs/intro.md
index b1ce4c72..084f9450 100644
--- a/docs/docs/intro.md
+++ b/docs/docs/intro.md
@@ -4,17 +4,17 @@
 
 ## Quickstart
 
-1. Try out `Continue` in the [GitHub Codespaces Demo](./getting-started.md)
-2. Install `Continue` packaged as a [VS Code extension](./install.md)
+1. Try out Continue in the [GitHub Codespaces Demo](./getting-started.md)
+2. Install Continue packaged as a [VS Code extension](./install.md)
 
 ## What is `Continue`?
 
-**`Continue` is the open-source library for accelerating software development with language models**
+**Continue is the open-source library for accelerating software development with language models**
 
 You define the scenarios where Large Language Models ([LLMs](./concepts/llm.md)) like GPT-4 and StarCoder should act as an autopilot, helping you complete software development tasks. You use [recipes](./concepts/recipe.md) created by others to automate more steps in your workflows. If a [recipe](./concepts/recipe.md) does not exist or work exactly like you want, you can use the [Continue SDK](./concepts/sdk.md) to create custom [steps](./concepts/step.md) and compose them into personalized [recipes](./concepts/recipe.md). Whether you are using a [recipe](./concepts/recipe.md) created by yourself or someone else, you can review, reverse, and rerun [steps](./concepts/step.md) with the [Continue GUI](./concepts/gui.md), which helps you guide the work done by LLMs and learn when to use and trust them.
 
 ## Why do developers use `Continue`?
 
-Many developers have begun to use models like [GPT-4](https://openai.com/research/gpt-4) through [ChatGPT](https://openai.com/blog/chatgpt) while coding; however, the experience is painful because of how much manual copying, pasting, and editing is required to supply them with context and transfer the generated solutions to your codebase. `Continue` eliminates this pain by deeply integrating LLMs into your IDE amd workflows.
+Many developers have begun to use models like [GPT-4](https://openai.com/research/gpt-4) through [ChatGPT](https://openai.com/blog/chatgpt) while coding; however, the experience is painful because of how much manual copying, pasting, and editing is required to supply them with context and incorporate the generated solutions into your codebase. Continue eliminates this pain by deeply integrating LLMs into your IDE amd workflows.
 
-`Continue` accelerates how developers build, ship, and maintain software, while giving them the control to define when LLMs should take actions and the confidence to trust LLMs. In short, it enables developers to do what they have always done: work together to create better and better abstractions that make it easier and easier to automate the repetitive work that people want computers to do.
+Continue accelerates how developers build, ship, and maintain software, while giving them the control to define when LLMs should take actions and the confidence to trust LLMs. In short, it enables developers to do what they have always done: work together to create better and better abstractions that make it easier and easier to automate the repetitive work that people want computers to do.
\ No newline at end of file
diff --git a/docs/docs/telemetry.md b/docs/docs/telemetry.md
index c5e938dd..47f5a171 100644
--- a/docs/docs/telemetry.md
+++ b/docs/docs/telemetry.md
@@ -12,10 +12,12 @@ We track the following...
 

 ## How to opt out

 

+**TODO: Define where the root of your workspace**

+

 Create a `continue.json` file in the root of your workspace and add the following:

 

 ```json

 {

   "allow_anonymous_telemetry": false

 }

-```

+```
\ No newline at end of file
diff --git a/docs/docs/walkthroughs/create-a-recipe.md b/docs/docs/walkthroughs/create-a-recipe.md
index 12dd3167..6a32906a 100644
--- a/docs/docs/walkthroughs/create-a-recipe.md
+++ b/docs/docs/walkthroughs/create-a-recipe.md
@@ -1,5 +1,7 @@
 # Create a recipe

 

+Check out the [recipes folder](https://github.com/continuedev/continue/tree/main/continuedev/src/continuedev/recipes) to learn how to write your own.

+

 **TODO: Describe step-by-step how to create a recipe**

 

 Points to include

diff --git a/docs/sidebars.js b/docs/sidebars.js
index b3ebec57..89b20617 100644
--- a/docs/sidebars.js
+++ b/docs/sidebars.js
@@ -33,7 +33,7 @@ const sidebars = {
       label: "Concepts",
       items: [
         "concepts/autopilot",
-        "concepts/server",
+        "concepts/continue-json",
         "concepts/gui",
         "concepts/history",
         "concepts/ide",
@@ -41,6 +41,7 @@ const sidebars = {
         "concepts/policy",
         "concepts/recipe",
         "concepts/sdk",
+        "concepts/server",
         "concepts/step",
       ],
     },
diff --git a/docs/src/components/HomepageFeatures/index.js b/docs/src/components/HomepageFeatures/index.js
index 0c5d8272..31df2b27 100644
--- a/docs/src/components/HomepageFeatures/index.js
+++ b/docs/src/components/HomepageFeatures/index.js
@@ -8,8 +8,8 @@ const FeatureList = [
     Svg: require("@site/static/img/undraw_docusaurus_mountain.svg").default,
     description: (
       <>
-        Seamlessly put your repetitive software development tasks on autopilot
-        by leveraging recipes created by others
+        Seamlessly put your repetitive software development tasks 
+        on autopilot by leveraging recipes created by others
       </>
     ),
   },
@@ -18,9 +18,8 @@ const FeatureList = [
     Svg: require("@site/static/img/undraw_docusaurus_tree.svg").default,
     description: (
       <>
-        Use the Continue SDK to create your own custom steps and compose them
-        into personalized recipes, guiding LLMs through common sequences of
-        tasks
+        Use the Continue SDK to create custom steps and compose 
+        them into recipes, guiding LLMs through common tasks
       </>
     ),
   },
@@ -29,8 +28,8 @@ const FeatureList = [
     Svg: require("@site/static/img/undraw_docusaurus_react.svg").default,
     description: (
       <>
-        Use the Continue GUI to review, reverse, and rerun steps or even entire
-        recipes, allowing you to build trust in LLMs
+        Use the Continue GUI to review, reverse, and rerun steps or even 
+        entire recipes, allowing you to build trust in language models
       </>
     ),
   },
@@ -62,4 +61,4 @@ export default function HomepageFeatures() {
       </div>
     </section>
   );
-}
+}
\ No newline at end of file
diff --git a/extension/README.md b/extension/README.md
index 51e95822..9ee59ad3 100644
--- a/extension/README.md
+++ b/extension/README.md
@@ -1,27 +1,5 @@
 # Continue
 
-Automate software development at the level of tasks, instead of tab-autocompletions. With Continue, you can make large edits with natural language, ask questions of your codebase, and run custom recipes built with our open-source Python library.
+**[Continue](https://continue.dev/docs) is the open-source library for accelerating software development with language models**
 
-Get started by opening the command pallet with `cmd+shift+p` and then selecting `Continue: Open Debug Panel`.
-
-# Features
-
-### Ask a Question
-
-Ask natural language questions of your codebase, like "Where is the entry point to the VS Code extension?"
-
-### Edit with Natural Language
-
-Request an edit to the currently open file, for example: "Add CORS headers to this FastAPI server".
-
-### Generate a Fix
-
-Once Continue has code snippets to work with, it can generate a fix. Just click to accept or reject, or make the tweak you need.
-
-### Stacktrace Parsing
-
-Any stacktrace that appears in your VS Code terminal will be caught by us so we can immediately begin the debugging process. For small bugs that you might have quickly solved, we'll just speed up the process to be nearly instantaneous.
-
-### Generate Unit Tests and Docstrings
-
-Use `cmd+shift+i` to generate a unit test for the function surrounding your cursor position, and `cmd+shift+l` to generate a docstring.
+You can find the Continue GitHub repo [here](https://github.com/continuedev/continue)
\ No newline at end of file