filling in walkthroughs

13 files changed, 138 insertions, 40 deletions

diff --git a/docs/docs/catalog.md b/docs/docs/catalog.md
new file mode 100644
index 00000000..25b1214d
--- /dev/null
+++ b/docs/docs/catalog.md
@@ -0,0 +1,33 @@
+# Catalog

+

+## Steps

+

+**TODO: better explain each step and link to them**

+

+#### EditCodeStep

+

+Provide a prompt and a list of file ranges to be edited by a language model

+

+### ManualEditStep

+

+Tracks all user edits in the IDE so that they can be reversed along with other steps

+

+### CreateTableStep

+

+Create a table in TypeORM

+

+### MigrationStep

+

+Create and run an alembic migration

+

+### WritePytestsRecipe

+

+Write unit tests for this file

+

+### AnswerQuestionChromaStep

+

+Type `/ask` and ask any question about your whole codebase. The Chroma embeddings store will help find important snippets and answer your question

+

+## Recipes

+

+**TODO: add each recipe, explain them, and link to them**
\ No newline at end of file
diff --git a/docs/docs/concepts/continue-json.md b/docs/docs/concepts/continue-json.md
deleted file mode 100644
index f176bdff..00000000
--- a/docs/docs/concepts/continue-json.md
+++ /dev/null
@@ -1,3 +0,0 @@
-# config.json

-

-**TODO: Need to explain this**

diff --git a/docs/docs/concepts/credentials.md b/docs/docs/concepts/credentials.md
new file mode 100644
index 00000000..a2cf90e0
--- /dev/null
+++ b/docs/docs/concepts/credentials.md
@@ -0,0 +1,7 @@
+# Credentials

+

+**TODO: where to add / edit / remove API keys**

+

+Recipes on per model basis (make sure you have added API key)

+

+Models from OpenAI will require an API key

diff --git a/docs/docs/concepts/recipe.md b/docs/docs/concepts/recipe.md
index da2b6264..5e03551b 100644
--- a/docs/docs/concepts/recipe.md
+++ b/docs/docs/concepts/recipe.md
@@ -12,4 +12,4 @@ When enough steps are strung together they become a recipe. Can kick off with sl
 

 - Although technically just a step itself, since they also subclass the Step class, recipes differentiate themselves from normal steps by ending their name with `Recipe` by

 - Technically, everything is a step since everything subclasses the step class. Steps can be composed together. Once steps are composed into a workflow that developers use and share with others, that step is called a recipe and, by convention, it ends with Recipe to signal this

-- Actually just a step that is composed of only other steps / recipes.

+- Actually just a step that is composed of only other steps / recipes.
\ No newline at end of file
diff --git a/docs/docs/getting-started.md b/docs/docs/getting-started.md
index 2ffa7227..ce52bd12 100644
--- a/docs/docs/getting-started.md
+++ b/docs/docs/getting-started.md
@@ -12,7 +12,7 @@ We don't want to waste your time with install and env setup before you try Conti
 

 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: Adding image of Codespaces once its ready to be used**

+**TODO: Add image of Codespaces after it starts up**

 

 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)

 

diff --git a/docs/docs/how-continue-works.md b/docs/docs/how-continue-works.md
index 436f7506..c139afa0 100644
--- a/docs/docs/how-continue-works.md
+++ b/docs/docs/how-continue-works.md
@@ -10,6 +10,6 @@ The `Continue` library consists of an [SDK](./concepts/sdk.md), a [GUI](./concep
 

 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 the IDE, SDK, and GUI together as well as deciding which steps to take next.

+3. The [Server](./concepts/server.md) is responsible for connecting the IDE, SDK, and GUI together as well as deciding which steps to take next.

 

-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
+The Continue Server take actions in the IDE code editor as directed by recipes, which are written using the Continue SDK and run by a user using the Continue GUI.
\ No newline at end of file
diff --git a/docs/docs/install.md b/docs/docs/install.md
index 4c75bc4a..5a56dbab 100644
--- a/docs/docs/install.md
+++ b/docs/docs/install.md
@@ -14,6 +14,16 @@ If you want to try Continue before installing locally, check out the [GitHub Cod
 

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

 

+You can also open the Continue GUI with `cmd+shift+p` on Mac / `ctrl+shift+p` on Windows and then selecting `Continue: Open Debug Panel`

+

+4. To test a few common recipes, open a blank python file and try the following:

+- Ask it to "write me a calculator class in python"

+- /comment to write comments for the class

+- /pytest to write Pytest unit tests in a separate file

+- Ask in natural language for a new method

+

+**TODO: Can we have one getting started workflow across VS Code and GitHub Codespaces?**

+

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

 :::

diff --git a/docs/docs/intro.md b/docs/docs/intro.md
index 084f9450..6a04f678 100644
--- a/docs/docs/intro.md
+++ b/docs/docs/intro.md
@@ -7,14 +7,14 @@
 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`?
+## What is Continue?
 
 **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.
+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 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. Whether you are using a recipe created by yourself or someone else, you can review, reverse, and rerun steps 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`?
+## 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 incorporate the generated solutions into your codebase. Continue eliminates this pain by deeply integrating LLMs into your IDE amd workflows.
+Many developers have begun to use [GPT-3.5](https://platform.openai.com/docs/models/gpt-3-5) and [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 provide the necessary 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.
\ No newline at end of file
diff --git a/docs/docs/telemetry.md b/docs/docs/telemetry.md
index 23521f3b..d0b04180 100644
--- a/docs/docs/telemetry.md
+++ b/docs/docs/telemetry.md
@@ -2,13 +2,13 @@
 

 ## Overview

 

-`Continue` collects and reports **anonymous** usage information. This data is essential to understanding how we should improve the library. You can opt out of it at any time.

+Continue collects and reports **anonymous** usage information. This data is essential to understanding how we should improve the library. You can opt out of it at any time.

 

-We use [Posthog](https://posthog.com/), an open source platform for product analytics, to collect and store the data.

+We use [Posthog](https://posthog.com/), an open source platform for product analytics, to collect and store the data. You can review the code [here](https://github.com/continuedev/continue/tree/main/continuedev/src/continuedev/libs/util/telemetry.py).

 

 ## What we track

 

-We track the steps that are run and their parameters

+We track the steps that are run and their parameters.

 

 ## How to opt out

 

diff --git a/docs/docs/walkthroughs/share-a-recipe.md b/docs/docs/walkthroughs/share-a-recipe.md
index a5f7ef50..44e7e367 100644
--- a/docs/docs/walkthroughs/share-a-recipe.md
+++ b/docs/docs/walkthroughs/share-a-recipe.md
@@ -2,8 +2,20 @@
 

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

 

-Points to include

-- Where to create recipes

-- What you need to contribute them (README, style, etc)

-- How to push them

-- How to get them reviewed
\ No newline at end of file
+## 1. Verify checklist

+

+- [] Make sure you added them in right spot. All of the recipes are located in this part of the codebase here

+- [] Make sure to add a README

+- [] Make sure you have a main recipe file

+

+## 2. Push to codebase (fork codebase first?)

+

+## 3. Ask for review

+

+Ask for review from @tydunn or @natesesti

+

+## 4. Address review feedback

+

+Push your changes

+

+## 5. We approve
\ No newline at end of file
diff --git a/docs/docs/walkthroughs/use-a-recipe.md b/docs/docs/walkthroughs/use-a-recipe.md
index e230030e..21f81428 100644
--- a/docs/docs/walkthroughs/use-a-recipe.md
+++ b/docs/docs/walkthroughs/use-a-recipe.md
@@ -1,16 +1,38 @@
 # Use a recipe

 

-**TODO: Describe how to use a recipe**

-

-Points to include

-- How to get recipes

-- Slash commands

-- READMEs with instructions for each recipe?

-- Using GUI

-- Reviewing

-- Reversing

-- Rerunning

-- Follow the instructions

-- Customizing recipe

-- Recipes on per model basis (make sure you have added API key)

-- Creating a recipe from scratch (link)
\ No newline at end of file
+## Select a recipe that you want to use

+

+You can learn more about the recipes that exist and how they work in the [Catalog](../catalog.md)

+

+All of the recipes are located in this part of the codebase here

+

+## Open the file you want the LLM to edit

+

+At the moment, we only support editing the file open and focused in the code editor, so you need to make sure that is 

+

+## Use its slash command to start the recipe

+

+Every recipe can be triggered by the user using its slash command. For example, `/comment` will trigger

+

+## Review the steps and take any required manual actions

+

+Make sure that the recipe works as expected

+follow any instructions

+

+## Reverse if something goes wrong

+

+Click this button

+

+## Rerun

+

+add feedback to modify how it runs

+LLMs are non-determistic, so rerunning again might 

+

+

+## Customizing the recipe

+

+If the recipe does not work exactly like you want, you can adjust it. Find the code for recipe here and then learn how to [create a recipe](./create-a-recipe.md) understand what you need to do to get it work like you want

+

+## Creating your own recipe

+

+Learn how to [create a recipe](./create-a-recipe.md)
\ No newline at end of file
diff --git a/docs/docs/walkthroughs/use-the-gui.md b/docs/docs/walkthroughs/use-the-gui.md
index c244b461..c9dc17c2 100644
--- a/docs/docs/walkthroughs/use-the-gui.md
+++ b/docs/docs/walkthroughs/use-the-gui.md
@@ -2,11 +2,27 @@
 

 **TODO: Describe how to use the `Continue GUI`**

 

-Points to include

-- Recipes

-- Steps

-- Single turn at the moment

+## Open the file you want the LLM to edit

+

+At the moment, we only support editing the file open and focused in the code editor, so you need to make sure that is

+

+Note: single turn at the moment

+

 - Opening the (set of) file(s) you want to edit

 - Then giving natural language instructions

-- Reversing

-- Modifying with feedback
\ No newline at end of file
+

+## Review actions taken

+

+make sure it takes action you approve

+

+## Reverse button

+

+undo things done by steps

+

+## Rerun

+

+continue button (with optional modify)

+

+## Recipes

+

+Learn how to use recipes
\ No newline at end of file
diff --git a/docs/sidebars.js b/docs/sidebars.js
index 89b20617..6714f6f0 100644
--- a/docs/sidebars.js
+++ b/docs/sidebars.js
@@ -33,7 +33,7 @@ const sidebars = {
       label: "Concepts",
       items: [
         "concepts/autopilot",
-        "concepts/continue-json",
+        "concepts/credentials",
         "concepts/gui",
         "concepts/history",
         "concepts/ide",
@@ -45,6 +45,7 @@ const sidebars = {
         "concepts/step",
       ],
     },
+    "catalog",
     "telemetry",
   ],
 };