diff options
| author | Ty Dunn <ty@tydunn.com> | 2023-06-04 10:35:45 +0200 |
|---|---|---|
| committer | Ty Dunn <ty@tydunn.com> | 2023-06-04 10:35:45 +0200 |
| commit | 224b16bd0427be90bfd20aa32550a6388db3ad86 (patch) | |
| tree | 1f587c589d22b83eaee586a1d4cc4fa399284498 /docs/docs/walkthroughs/use-a-recipe.md | |
| parent | 4fe0f84790a7e906924e01cbb2dd79a6944d21f4 (diff) | |
| download | sncontinue-224b16bd0427be90bfd20aa32550a6388db3ad86.tar.gz sncontinue-224b16bd0427be90bfd20aa32550a6388db3ad86.tar.bz2 sncontinue-224b16bd0427be90bfd20aa32550a6388db3ad86.zip | |
filling in walkthroughs
Diffstat (limited to 'docs/docs/walkthroughs/use-a-recipe.md')
| -rw-r--r-- | docs/docs/walkthroughs/use-a-recipe.md | 48 |
1 files changed, 35 insertions, 13 deletions
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**
+## Select a recipe that you want to use
-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 +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 |