summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorTy Dunn <ty@tydunn.com>2023-06-04 15:37:09 +0200
committerTy Dunn <ty@tydunn.com>2023-06-04 15:37:09 +0200
commit56a438f9ce0daaddf77299d5ed54f19b72053b45 (patch)
tree8409569831c972ed025f7ef56d33089584a53705
parent224b16bd0427be90bfd20aa32550a6388db3ad86 (diff)
downloadsncontinue-56a438f9ce0daaddf77299d5ed54f19b72053b45.tar.gz
sncontinue-56a438f9ce0daaddf77299d5ed54f19b72053b45.tar.bz2
sncontinue-56a438f9ce0daaddf77299d5ed54f19b72053b45.zip
more walkthrough changes
-rw-r--r--docs/docs/concepts/step.md42
-rw-r--r--docs/docs/walkthroughs/use-a-recipe.md1
-rw-r--r--docs/docs/walkthroughs/use-the-gui.md29
3 files changed, 20 insertions, 52 deletions
diff --git a/docs/docs/concepts/step.md b/docs/docs/concepts/step.md
index 0358a52f..a58d3b19 100644
--- a/docs/docs/concepts/step.md
+++ b/docs/docs/concepts/step.md
@@ -32,44 +32,4 @@ the code that should run when the step is reversed
### `modify` (optional)
-the code that should run when the step is rerun with feedback
-
-**TODO: Move the below list / description of all steps and recipes to the place where people will be able to use, update, share them**
-
-## Steps & recipes
-
-### Core
-
-#### EditCodeStep
-
-Provide a prompt and a list of file ranges to be edited by a language model.
-
-### ManualEditStep
-
-A core step that tracks all user edits in the IDE so that they can be reversed along with other steps
-
-## Community
-
-### CreateTableStep
-
-Create a table in TypeORM
-
-### MigrationStep
-
-Create and run an alembic migration
-
-#### Parameters
-
-- `edited_file`:
-
-### WritePytestsRecipe
-
-Write unit tests for this file.
-
-#### Parameters
-
-- for_filepath (required): the path of the file that unit tests should be created for
-
-### AnswerQuestionChromaStep
-
-Type `/ask` and ask any question about your whole codebase. The Chroma embeddings store will help find important snippets and answer your question.
+the code that should run when the step is rerun with feedback \ 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 21f81428..a5be199e 100644
--- a/docs/docs/walkthroughs/use-a-recipe.md
+++ b/docs/docs/walkthroughs/use-a-recipe.md
@@ -28,7 +28,6 @@ Click this button
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
diff --git a/docs/docs/walkthroughs/use-the-gui.md b/docs/docs/walkthroughs/use-the-gui.md
index c9dc17c2..055150c7 100644
--- a/docs/docs/walkthroughs/use-the-gui.md
+++ b/docs/docs/walkthroughs/use-the-gui.md
@@ -1,28 +1,37 @@
# Use the GUI
-**TODO: Describe how to use the `Continue GUI`**
+## How to edit a file using LLMs
-## Open the file you want the LLM to edit
+1. Open the file you want 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
+2. Give instructions in natural language for how you want the file to be edited
-Note: single turn at the moment
+3. Press the `Continue` button
-- Opening the (set of) file(s) you want to edit
-- Then giving natural language instructions
+4. Review the explaination of what was edited and why on the Continue GUI
+
+5. Check the code that was edited by the LLM in the code editor
+
+:::note
+At the moment, we only supporting the file that is opened and focused on in the code editor
+:::
+
+:::note
+Context is not carried across steps at the moment, so you will need to repeat any information from previous steps if you want the LLM in the current step to be aware of it
+:::
## Review actions taken
-make sure it takes action you approve
+Whether you are using a recipe or not, you will want to review the explainations of what the LLM did and check the code that it generated. You are ultimately responsible for any code that you ship, even if it was written by a LLM.
## Reverse button
undo things done by steps
-## Rerun
+## Rerun steps and recipes
continue button (with optional modify)
-## Recipes
+## How to use recipes
-Learn how to use recipes \ No newline at end of file
+You can learn how to use recipes [here](./use-a-recipe.md) \ No newline at end of file