@shoalrun/cli 0.1.0-alpha.16 → 0.1.0-alpha.17

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (103) hide show
  1. package/CHANGELOG.md +17 -0
  2. package/README.md +3 -3
  3. package/agent-docs/SNAPSHOT.json +5 -5
  4. package/agent-docs/author/frontmatter-reference.md +15 -11
  5. package/agent-docs/author/frontmatter-reference.sections/choose-a-publication-and-visibility.md +13 -11
  6. package/agent-docs/author/frontmatter-reference.sections/control-output-details.md +1 -1
  7. package/agent-docs/author/frontmatter-reference.sections/global-defaults-and-enforced-values.md +1 -1
  8. package/agent-docs/author/frontmatter-reference.sections/html-markdown-and-agents.md +1 -1
  9. package/agent-docs/author/frontmatter-reference.sections/identify-and-route-a-page.md +1 -1
  10. package/agent-docs/author/frontmatter-reference.sections/point-agents-to-it.md +1 -1
  11. package/agent-docs/author/frontmatter-reference.sections/project-defined-fields.md +1 -1
  12. package/agent-docs/author/frontmatter-reference.sections/related-reading.md +1 -1
  13. package/agent-docs/author/frontmatter-reference.sections/use-the-local-files-while-authoring.md +1 -1
  14. package/agent-docs/author/frontmatter-reference.sections/when-the-files-update.md +1 -1
  15. package/agent-docs/author/recipe-drafts.md +2 -2
  16. package/agent-docs/author/recipe-drafts.sections/1-write-one-reusable-step.md +1 -1
  17. package/agent-docs/author/recipe-drafts.sections/2-list-the-steps-for-one-complete-goal.md +1 -1
  18. package/agent-docs/author/recipe-drafts.sections/3-generate-a-draft-and-review-it.md +1 -1
  19. package/agent-docs/author/recipe-drafts.sections/4-maintain-shoalrun-s-published-recipe-snapshots.md +1 -1
  20. package/agent-docs/author/recipe-drafts.sections/related-reading.md +1 -1
  21. package/agent-docs/author/recipe-drafts.sections/start-an-ingredient-from-an-api-example.md +2 -2
  22. package/agent-docs/author/recipes.md +3 -3
  23. package/agent-docs/author/recipes.sections/how-agents-use-this.md +2 -2
  24. package/agent-docs/author/recipes.sections/one-example-from-shoalrun.md +2 -2
  25. package/agent-docs/author/recipes.sections/related-reading.md +2 -2
  26. package/agent-docs/author/recipes.sections/try-a-complete-workflow.md +3 -3
  27. package/agent-docs/author/recipes.sections/use-recipes-for-task-oriented-how-tos.md +2 -2
  28. package/agent-docs/author/recipes.sections/what-changing-an-ingredient-updates.md +2 -2
  29. package/agent-docs/author/recipes.sections/what-each-file-does.md +2 -2
  30. package/agent-docs/author/recipes.sections/what-happens-and-when.md +2 -2
  31. package/agent-docs/author/search.md +55 -6
  32. package/agent-docs/author/search.sections/agent-and-mcp-search-scope.md +48 -0
  33. package/agent-docs/author/search.sections/choose-a-provider.md +7 -6
  34. package/agent-docs/author/search.sections/cli-and-mcp-ranking-details.md +1 -1
  35. package/agent-docs/author/search.sections/enable-included-semantic-search.md +66 -0
  36. package/agent-docs/author/search.sections/hosted-semantic-search-limits.md +1 -1
  37. package/agent-docs/author/search.sections/html-markdown-and-agents.md +1 -1
  38. package/agent-docs/author/search.sections/lexical-search.md +1 -1
  39. package/agent-docs/author/search.sections/local-semantic-preview.md +1 -1
  40. package/agent-docs/author/search.sections/read-a-search-result-with-an-agent.md +1 -1
  41. package/agent-docs/author/search.sections/related-reading.md +1 -1
  42. package/agent-docs/author/search.sections/reuse-the-lexical-index.md +1 -1
  43. package/agent-docs/author/search.sections/turn-search-off.md +1 -1
  44. package/agent-docs/author/search.sections/use-the-search-box.md +1 -1
  45. package/agent-docs/author/search.sections/write-a-custom-provider.md +1 -1
  46. package/agent-docs/chat/passage-index.md +16 -12
  47. package/agent-docs/chat/passage-index.sections/build-the-index.md +3 -3
  48. package/agent-docs/chat/passage-index.sections/embed-passages.md +3 -3
  49. package/agent-docs/chat/passage-index.sections/how-the-default-chunker-splits-a-page.md +3 -3
  50. package/agent-docs/chat/passage-index.sections/limits.md +3 -3
  51. package/agent-docs/chat/passage-index.sections/passage-ids-and-links.md +14 -10
  52. package/agent-docs/chat/passage-index.sections/related-reading.md +3 -3
  53. package/agent-docs/chat/passage-index.sections/what-a-passage-contains.md +5 -5
  54. package/agent-docs/cookbooks/welcome-email.md +12 -9
  55. package/agent-docs/documents.json +207 -183
  56. package/agent-docs/provenance.json +4 -4
  57. package/agent-docs/recipes/queue-email.md +1 -1
  58. package/agent-docs/recipes/send-welcome-email.md +3 -3
  59. package/agent-docs/search-index.json +1 -1
  60. package/agent-docs/start.md +2 -2
  61. package/agent-docs/start.sections/add-the-page-to-navigation.md +1 -1
  62. package/agent-docs/start.sections/build-and-check-both-outputs.md +1 -1
  63. package/agent-docs/start.sections/build-this-site.md +1 -1
  64. package/agent-docs/start.sections/check-writing-style.md +1 -1
  65. package/agent-docs/start.sections/create-a-page.md +1 -1
  66. package/agent-docs/start.sections/make-it-yours.md +1 -1
  67. package/agent-docs/start.sections/migrating-from-github-packages.md +1 -1
  68. package/agent-docs/start.sections/prerequisites.md +1 -1
  69. package/agent-docs/start.sections/related-reading.md +1 -1
  70. package/agent-docs/start.sections/start-your-own-project.md +2 -2
  71. package/dist/ai-directory.d.ts +1 -0
  72. package/dist/ai-directory.js +12 -0
  73. package/dist/answer-cards.js +1 -1
  74. package/dist/ask-function.d.ts +4 -18
  75. package/dist/ask-function.js +12 -71
  76. package/dist/ask-runtime.d.ts +45 -0
  77. package/dist/ask-runtime.js +96 -0
  78. package/dist/ask-setup.d.ts +3 -42
  79. package/dist/ask-setup.js +5 -93
  80. package/dist/embeddings.d.ts +1 -1
  81. package/dist/embeddings.js +1 -1
  82. package/dist/function-package.js +5 -0
  83. package/dist/function-runtime.d.ts +23 -0
  84. package/dist/function-runtime.js +45 -0
  85. package/dist/index-build.d.ts +1 -2
  86. package/dist/index-build.js +3 -11
  87. package/dist/retrieval-runtime.d.ts +5 -0
  88. package/dist/retrieval-runtime.js +21 -0
  89. package/dist/search-function.d.ts +2 -0
  90. package/dist/search-function.js +30 -0
  91. package/dist/search-handler.js +2 -2
  92. package/dist/search-identifier-core.d.ts +4 -0
  93. package/dist/search-identifier-core.js +30 -0
  94. package/dist/search-identifier.d.ts +3 -3
  95. package/dist/search-identifier.js +7 -30
  96. package/dist/search-literal.js +1 -1
  97. package/dist/search-results.js +1 -1
  98. package/dist/search-snippet.d.ts +1 -1
  99. package/dist/search-snippet.js +2 -14
  100. package/dist/search-text.d.ts +1 -0
  101. package/dist/search-text.js +14 -0
  102. package/dist/vercel-function.js +10 -2
  103. package/package.json +1 -1
package/agent-docs/cookbooks/welcome-email.md CHANGED
@@ -1,28 +1,31 @@
1
1
  ---
2
2
  id: cookbook.welcome-email
3
- title: Welcome email workflows
4
- summary: Choose an acceptance check or follow the same message through delivery.
3
+ title: Cookbook example
4
+ summary: Compare recipe choices and see how a cookbook reuses instructions
5
+ across workflows.
5
6
  type: cookbook
6
- area: api
7
- subarea: api-examples
7
+ area: authoring
8
+ subarea: authoring-composition
8
9
  canonical: /cookbooks/welcome-email
9
10
  ---
10
11
 
11
- # Welcome email workflows
12
+ # Cookbook example
12
13
 
13
14
  > Documentation index: [llms.min.txt](https://www.shoalrun.com/llms.min.txt) · Document manifest: [documents.json](https://www.shoalrun.com/documents.json)
14
15
 
15
16
  Navigation section: [Examples](https://www.shoalrun.com/.well-known/shoalrun/navigation/examples-tab-50f26fe22670.txt) (ID: examples-tab). [All sections and pages](https://www.shoalrun.com/llms.min.txt)
16
17
 
17
- Breadcrumbs: [Examples](https://www.shoalrun.com/config/examples.md) > Email simulation > Email simulation
18
+ Breadcrumbs: [Examples](https://www.shoalrun.com/config/examples.md) > Cookbook example > Cookbook example
18
19
 
19
- **Updated: 2026-10-27.**
20
+ **Updated: 2026-11-04.**
20
21
 
21
- An accepted request is the first checkpoint. Choose how far you want to follow the message. Both paths use a local simulation that sends no email.
22
+ This worked example shows how a cookbook presents complete recipes and reuses instructions across them. Choose a short acceptance check or a longer delivery workflow; the delivery recipe includes the same queue step.
23
+
24
+ Email is the sample task. Both recipes use a local simulator that sends no email. The reusable pattern is choosing an outcome, following the selected recipe, and carrying one step’s output into the next step.
22
25
 
23
26
  Each recipe includes the setup command, inputs, and success check. You need a Shoalrun checkout, cURL, and Node.js. The demo runs on your own computer at `127.0.0.1:8787`.
24
27
 
25
- ## Choose your outcome
28
+ ## Choose a recipe
26
29
 
27
30
  What do you need to confirm?. Choose one recipe.
28
31