Repository navigation
docs: Cookbooks tab for Stagehand workflows - #2789
antonvishal wants to merge 21 commits into
Conversation
|
|
This PR is from an external contributor and must be approved by a stagehand team member with write access before CI can run. |
6d33677 to
a4de127
Compare
# Conflicts: # packages/docs/docs.json
charlypoly
left a comment
There was a problem hiding this comment.
Hi @antonvishal, thank you for this 🙌🏼
I think this is a core missing piece of our docs, so let's make it happen!
A couple of things I'd like to change:
- The navigation is a bit overcomplicated as it stands, we should add hierarchy (categories) once we reach a critical number of cookbooks (>10-15)
- Each cookbook should come as both a prompt and a folder in the repo to checkout, I'm not sure people spend time copy-pasting these days
- We need to revisit some of them that are closer to snippets than cookbook (not covering a specific enough use cases): Multi-page Workflows, Extract a paginated catalog, Compare pages in parallel. Either we extend them or we revisit the menu to have 2 categories: Cookbook and Snippets/Patterns
Hey @charlypoly , I’ve kept the Examples navigation flat, added a prompt and runnable repo folder for each cookbook, and expanded the pages into a consistent guide format. I’ve attached a screenshot of the updated cookbook. How does the page look? Any other edits you’d like first?
|
|
Review the following changes in direct dependencies. Learn more about Socket for GitHub. |
# Conflicts: # packages/docs/docs.json
# Conflicts: # packages/examples/README.md
…RBASE_API_KEY and OPENAI_API_KEY in .env setup
…d updated environment variable details
Co-authored-by: Cursor <cursoragent@cursor.com> # Conflicts: # packages/docs/docs.json
Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
TypeScript launch options take timeout in seconds, not Python's api_timeout alias. Create a context when BROWSERBASE_CONTEXT_ID is unset. Co-authored-by: Cursor <cursoragent@cursor.com>
|
This PR was approved by @charlypoly and mirrored to #3116. All further discussion should happen on that PR. |
Mirrored from external contributor PR #2789 after approval by @charlypoly. Original author: @antonvishal Original PR: #2789 Approved source head SHA: `5d32c83ec49a1d1dfb1ce40d42a74593196635bc` @antonvishal, please continue any follow-up discussion on this mirrored PR. When the external PR gets new commits, this same internal PR will be marked stale until the latest external commit is approved and refreshed here. ## Original description ## Why Humans and coding agents need browser workflows they can understand, reuse, and combine into new jobs. These cookbooks are meant to be building blocks. ## What - Add matching runnable projects under `packages/cookbooks`. - Keep the docs focused on the workflow and make each example easy for both humans and agents to understand and adapt. - Support TypeScript, Python, and Go for the core browser workflows. ## Follow-ups - [ ] Simplify the clone/sparse-checkout setup into a one-command start - [ ] Add more cookbooks by combining existing patterns into new workflows <img width="3008" height="1656" alt="BetterShot_2026-10-03-21-28-28" src="https://github.com/user-attachments/assets/5a9d7d59-4fdf-4fa6-a755-3378fbdab194" /> <!-- external-contributor-pr:owned source-pr=2789 source-sha=5d32c83ec49a1d1dfb1ce40d42a74593196635bc claimer=charlypoly --> <!-- This is an auto-generated description by cubic. --> --- ## Summary by cubic Adds a Cookbooks tab to the docs with five runnable browser workflow examples (persisted login, paginated catalog export, files to bucket, form submission approval, and an AI SDK research agent), each with an agent prompt, setup instructions, and source code. Reorganizes the existing example projects under `packages/examples/showcase` so cookbooks get their own directory, and updates the `justfile`, `.gitignore`, and code ownership accordingly. The new `just cookbook` command runs any cookbook from the repo root. **Migration** - `just cookbook` runs cookbooks that previously lived under `packages/examples`; the old `just cookbook <slug>` path for showcase scripts is now `just showcase-script`. - `.env` files for showcase examples now live in `packages/examples/showcase/.env` instead of `packages/examples/.env`. - The `saas-pricing-monitor` example script was removed as part of the showcase reorg; its workflow still exists under the showcase directory. <sup>Written for commit 40562dc. Summary will update on new commits.</sup> <a href="https://cubic.dev/pr/browserbase/stagehand/pull/3116?utm_source=github" target="_blank" rel="noopener noreferrer" data-no-image-dialog="true"><picture><source media="(prefers-color-scheme: dark)" srcset="https://www.cubic.dev/buttons/review-in-cubic-dark.svg"><source media="(prefers-color-scheme: light)" srcset="https://www.cubic.dev/buttons/review-in-cubic-light.svg"><img alt="Review in cubic" src="https://www.cubic.dev/buttons/review-in-cubic-dark.svg"></picture></a> <!-- End of auto-generated description by cubic. --> --------- Co-authored-by: Vishal Anton <vishalanton@appexert.com> Co-authored-by: VIshal Anton <166398166+antonvishal@users.noreply.github.com> Co-authored-by: Charly Poly <charly@browserbase.com> Co-authored-by: Claude Opus 5.5 <noreply@anthropic.com> Co-authored-by: Cursor <cursoragent@cursor.com> Co-authored-by: github-actions[bot] <41898282+github-actions[bot]@users.noreply.github.com>
|
The mirrored PR #3116 has been merged into |
browserbase#3116) Mirrored from external contributor PR browserbase#2789 after approval by @charlypoly. Original author: @antonvishal Original PR: browserbase#2789 Approved source head SHA: `5d32c83ec49a1d1dfb1ce40d42a74593196635bc` @antonvishal, please continue any follow-up discussion on this mirrored PR. When the external PR gets new commits, this same internal PR will be marked stale until the latest external commit is approved and refreshed here. ## Original description ## Why Humans and coding agents need browser workflows they can understand, reuse, and combine into new jobs. These cookbooks are meant to be building blocks. ## What - Add matching runnable projects under `packages/cookbooks`. - Keep the docs focused on the workflow and make each example easy for both humans and agents to understand and adapt. - Support TypeScript, Python, and Go for the core browser workflows. ## Follow-ups - [ ] Simplify the clone/sparse-checkout setup into a one-command start - [ ] Add more cookbooks by combining existing patterns into new workflows <img width="3008" height="1656" alt="BetterShot_2026-10-03-21-28-28" src="https://github.com/user-attachments/assets/5a9d7d59-4fdf-4fa6-a755-3378fbdab194" /> <!-- external-contributor-pr:owned source-pr=2789 source-sha=5d32c83ec49a1d1dfb1ce40d42a74593196635bc claimer=charlypoly --> <!-- This is an auto-generated description by cubic. --> --- ## Summary by cubic Adds a Cookbooks tab to the docs with five runnable browser workflow examples (persisted login, paginated catalog export, files to bucket, form submission approval, and an AI SDK research agent), each with an agent prompt, setup instructions, and source code. Reorganizes the existing example projects under `packages/examples/showcase` so cookbooks get their own directory, and updates the `justfile`, `.gitignore`, and code ownership accordingly. The new `just cookbook` command runs any cookbook from the repo root. **Migration** - `just cookbook` runs cookbooks that previously lived under `packages/examples`; the old `just cookbook <slug>` path for showcase scripts is now `just showcase-script`. - `.env` files for showcase examples now live in `packages/examples/showcase/.env` instead of `packages/examples/.env`. - The `saas-pricing-monitor` example script was removed as part of the showcase reorg; its workflow still exists under the showcase directory. <sup>Written for commit 40562dc. Summary will update on new commits.</sup> <a href="https://cubic.dev/pr/browserbase/stagehand/pull/3116?utm_source=github" target="_blank" rel="noopener noreferrer" data-no-image-dialog="true"><picture><source media="(prefers-color-scheme: dark)" srcset="https://www.cubic.dev/buttons/review-in-cubic-dark.svg"><source media="(prefers-color-scheme: light)" srcset="https://www.cubic.dev/buttons/review-in-cubic-light.svg"><img alt="Review in cubic" src="https://www.cubic.dev/buttons/review-in-cubic-dark.svg"></picture></a> <!-- End of auto-generated description by cubic. --> --------- Co-authored-by: Vishal Anton <vishalanton@appexert.com> Co-authored-by: VIshal Anton <166398166+antonvishal@users.noreply.github.com> Co-authored-by: Charly Poly <charly@browserbase.com> Co-authored-by: Claude Opus 5.5 <noreply@anthropic.com> Co-authored-by: Cursor <cursoragent@cursor.com> Co-authored-by: github-actions[bot] <41898282+github-actions[bot]@users.noreply.github.com>

Why
Humans and coding agents need browser workflows they can understand, reuse, and combine into new jobs.
These cookbooks are meant to be building blocks.
What
packages/cookbooks.Follow-ups