summaryrefslogtreecommitdiff
path: root/docs
diff options
context:
space:
mode:
authorTy Dunn <ty@tydunn.com>2023-06-05 08:53:48 +0200
committerTy Dunn <ty@tydunn.com>2023-06-05 08:53:48 +0200
commit0930f7048c9fcf5836cbee92e37a95f45693ded8 (patch)
treeeb0596e1db4bfb54a8a6974f215bb382f4bf8b24 /docs
parent4fdf41ae8df6f58c27b034dd75f7efd66d8f4919 (diff)
downloadsncontinue-0930f7048c9fcf5836cbee92e37a95f45693ded8.tar.gz
sncontinue-0930f7048c9fcf5836cbee92e37a95f45693ded8.tar.bz2
sncontinue-0930f7048c9fcf5836cbee92e37a95f45693ded8.zip
outcomes of work session
Diffstat (limited to 'docs')
-rw-r--r--docs/docs/catalog.md4
-rw-r--r--docs/docs/walkthroughs/create-a-recipe.md6
-rw-r--r--docs/docs/walkthroughs/use-a-recipe.md8
3 files changed, 15 insertions, 3 deletions
diff --git a/docs/docs/catalog.md b/docs/docs/catalog.md
index 25b1214d..b9e223e2 100644
--- a/docs/docs/catalog.md
+++ b/docs/docs/catalog.md
@@ -2,7 +2,7 @@
## Steps
-**TODO: better explain each step and link to them**
+**TODO: better explain each step and link to them, find all in steps folder**
#### EditCodeStep
@@ -30,4 +30,4 @@ Type `/ask` and ask any question about your whole codebase. The Chroma embedding
## Recipes
-**TODO: add each recipe, explain them, and link to them** \ No newline at end of file
+**TODO: add each recipe, explain them, and link to them, find all in recipes folder** \ 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 6a32906a..60bfe9a8 100644
--- a/docs/docs/walkthroughs/create-a-recipe.md
+++ b/docs/docs/walkthroughs/create-a-recipe.md
@@ -11,8 +11,14 @@ Points to include
- How to create recipe
- Using models
+1. Create a recipe here
+
+continue/continuedev/src/continuedev/recipes
+
## 1. Create a step
+
+
### a. Start by creating a subclass of Step
You should first consider what will be the parameters of your recipe. These are defined as attributes in the step, as with `input_file_path: str` below
diff --git a/docs/docs/walkthroughs/use-a-recipe.md b/docs/docs/walkthroughs/use-a-recipe.md
index a5be199e..dbe8901b 100644
--- a/docs/docs/walkthroughs/use-a-recipe.md
+++ b/docs/docs/walkthroughs/use-a-recipe.md
@@ -10,9 +10,15 @@ All of the recipes are located in this part of the codebase here
At the moment, we only support editing the file open and focused in the code editor, so you need to make sure that is
+user input step
+demopolicy decides what to do
+default step, starcoder to edit the current open file
+
## 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
+Every recipe can be triggered by the user using its slash command. For example, `/comment` will trigger.
+
+add to the if / else with `/` commands
## Review the steps and take any required manual actions