Skip to content

add python docs #787

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 23 commits into from
Jul 1, 2025
Merged

add python docs #787

merged 23 commits into from
Jul 1, 2025

Conversation

filip-michalsky
Copy link
Collaborator

why

its about time!

what changed

added python docs to mintlify

test plan

n/a

Copy link

changeset-bot bot commented May 31, 2025

⚠️ No Changeset found

Latest commit: 2bde981

Merging this PR will not cause a version bump for any packages. If these changes should not result in a new version, you're good to go. If these changes should result in a version bump, you need to add a changeset.

Click here to learn what changesets are, and how to add one.

Click here if you're a maintainer who wants to add a changeset to this PR

@filip-michalsky filip-michalsky requested a review from kamath June 14, 2025 01:38
@filip-michalsky filip-michalsky marked this pull request as ready for review June 14, 2025 01:38
Copy link
Contributor

@greptile-apps greptile-apps bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

PR Summary

Comprehensive addition of Python SDK documentation across Stagehand's documentation, including quickstart guides, examples, and integration patterns.

  • Added new docs/examples/python.mdx with complete Python SDK usage, Pydantic integration, and data science workflows
  • Updated docs/get_started/quickstart.mdx with Python installation and basic setup instructions
  • Enhanced docs/get_started/introduction.mdx with parallel Python code examples alongside TypeScript
  • Added Python section to docs/integrations/guides.mdx with CrewAI integration details
  • Updated navigation structure in docs.json to include Python documentation under Playbooks

5 files reviewed, 5 comments
Edit PR Review Bot Settings | Greptile

Copy link
Contributor

@Kylejeong2 Kylejeong2 left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

lots of changes to make, i'll probably make a PR with a bunch of stuff


Stagehand uses [Zod](https://zod.dev/) to help you define the schema of the data to be extracted.
Stagehand uses [Zod](https://zod.dev/) for JavaScript to help you define the schema of the data to be extracted. For Python, extraction returns structured data based on your instruction.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

should we say for typescript here, or is javascript fine

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

also do we use pydantic for the structured data?

@Kylejeong2 Kylejeong2 force-pushed the fm/stg-465-add-python-docs branch from 9ee7dca to cb9accd Compare June 23, 2025 19:29
@@ -16,6 +16,12 @@ icon: 'code'

Check out the [Next.js + Vercel example](https://github.com/browserbase/stagehand-nextjs-quickstart) to see how to build a Next.js app and one-click deploy it to Vercel.
Copy link
Collaborator Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@miguelg719 @Kylejeong2 this MDX file is excluded from the nav - Is this on purpose?

@filip-michalsky
Copy link
Collaborator Author

Comments addressed @Kylejeong2

also noticed integrations/guides.mdx does not show up in nav.. wonder if on purpose

@miguelg719 miguelg719 merged commit 5145788 into main Jul 1, 2025
1 check passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants