docs: recipe updates #3844
docs: recipe updates #3844
Conversation
|
| path: "./analyze.yaml" | ||
| values: | ||
| content: | | ||
| {{ raw_data | indent(2) }} |
There was a problem hiding this comment.
Nice! thanks for adding this in!
{{ raw_data | indent(2) }} mabye have more indent to align with the content
content: |
{{ raw_data | indent(2) }}
| ### Parameter Handling | ||
|
|
||
| Sub-recipes receive parameters in two ways: | ||
| Parameters received by sub-recipes can be used in prompts and instructions using `{{ parameter_name }}` syntax. Sub-recipes receive parameters in two ways: |
There was a problem hiding this comment.
for sub-recipes, they can run by itself.
So if they have their own params and used as sub-recipe, we can pass in the main recipe via
values:
content: content_value
There is another usage, the parameter value can be passed via session context so that the user does not have to specify.
I am sorry if I have confused you. I'll create some example recipe and share with you.
There was a problem hiding this comment.
🙏 Replaced "automatic inheritance" with "context-based parameters"
|
|
||
| 1. **Pre-set values**: Fixed parameter values defined in the `values` field are automatically provided and cannot be overridden at runtime | ||
| 2. **Automatic parameter inheritance**: Sub-recipes automatically have access to all parameters passed to the main recipe at runtime. | ||
| 2. **Automatic parameter inheritance**: Sub-recipes automatically have access to all parameters passed to the main recipe at runtime |
There was a problem hiding this comment.
Hi @dianed-square,
Sub-recipes automatically have access to all parameters passed to the main recipe at runtime
Comment
Sub-recipes will not have access to all parameters passed to the main recipe automatically. It still requires to pass along via Pre-set values
There was a problem hiding this comment.
Thanks @lifeizhou-ap ! I removed mention of "automatic inheritance" (also simplified the context-based parameter example)
|
Hi @dianed-square , Thank you for the amazing work! I saw the PR is still in draft mode, I will review it when it is ready. https://block.github.io/goose/docs/guides/recipes/sub-recipes/. Would you please also add |
|
@blackgirlbytes -- just want to run this by you first! Do you think it's better move the Sub-Recipes topic to the Experimental section or would you prefer to keep in place and just add the
|
hmmm, thanks for double checking! let's keep it on the recipe section and put an experimental warning. i know for recipes it's important for us to have it all in one spot for visibility's sake @dianed-square |
* main: Upgrade to MCP-UI ~5.6.2 and handle internalized auto iframe resizing (#3889) docs: recipe updates (#3844) added notes about reducing context window by referencing external files (#3895) Make the window title reflect what we are doing (#3883) additional metrics + Ui implementation (#3871) feat: Add session description editing functionality (#3819) Update filename in contributing docs (#3866) Fix voice dictation provider selection bug (#3862) doc: Update supported container runtimes (#3874) feat: add OAuth provider abstraction for CLI configuration (#3157) Don't ignore lockfiles on linux/windows builds (#3859) Use RMCP for StreamableHTTP OAuth support (#3845) Try to keep key order for Databricks (#3876) Fix OpenAI Provider with GitHub Models (#3875) Cmd click open finder (#3807) fix: recipe parameter form max height and not scrolling (#3879)
This PR documents new recipe features:
Also documents the
indent()filter for multi-line values per #3802.Documentation updates:
documentation/docs/guides/recipes/recipe-reference.md:sequential_when_repeatedsub-recipe fielddocumentation/docs/guides/recipes/session-recipes.md:documentation/docs/guides/recipes/sub-recipes.md:documentation/docs/tutorials/recipes-tutorial.md:documentation/docs/tutorials/sub-recipes-in-parallel.md:documentation/docs/guides/recipes/index.md: