Skip to content

Conversation

@shrey150
Copy link
Contributor

@shrey150 shrey150 commented Dec 6, 2025

why

Users don't know about the v2/v3 version toggle in the docs navigation.

what changed

Added a banner at the top of the v3 docs pages to help users easily discover Stagehand Python (v2).

test plan

n/a


Summary by cubic

Added a reusable banner to the top of all v3 docs pages to highlight the Stagehand Python (v2) option. Improves discoverability of the v2/v3 toggle and reduces confusion.

  • New Features
    • Added V3Banner MDX snippet linking to “/v2/first-steps/introduction”.
    • Imported and rendered the banner across v3 Basics, Best Practices, Configuration, First Steps, Integrations, Migrations, and References pages.
    • Minor metadata/formatting updates in v2 docs (e.g., User Data frontmatter) for consistency.

Written for commit 515a13d. Summary will update automatically on new commits.

@changeset-bot
Copy link

changeset-bot bot commented Dec 6, 2025

⚠️ No Changeset found

Latest commit: 515a13d

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.

This PR includes no changesets

When changesets are added to this PR, you'll see the packages that this PR includes changesets for and the associated semver types

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

Copy link
Contributor

@cubic-dev-ai cubic-dev-ai bot left a comment

Choose a reason for hiding this comment

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

No issues found across 53 files

@greptile-apps
Copy link
Contributor

greptile-apps bot commented Dec 6, 2025

Greptile Overview

Greptile Summary

Added a discoverable banner component to all v3 documentation pages to help users find the Python/v2 version of Stagehand. The banner includes a clear call-to-action link to switch to v2 docs.

  • Created reusable V3Banner component in snippets/v3-banner.mdx
  • Added banner to all 50 v3 documentation pages (basics, best-practices, configuration, integrations, migrations, references)
  • Fixed missing frontmatter in v2/best-practices/user-data.mdx and v3/best-practices/user-data.mdx
  • Added formatting consistency (blank line) in v2/best-practices/build-agent.mdx

The banner uses a clean, non-intrusive design with dark theme styling that matches the docs UI.

Confidence Score: 5/5

  • Safe to merge - simple documentation enhancement with consistent implementation across all files
  • This is a straightforward documentation change that adds a banner component to help users discover v2/Python docs. The implementation is consistent across all 50 v3 files, uses a reusable component pattern, and includes beneficial frontmatter fixes. No code logic changes, no breaking changes, no security concerns.
  • No files require special attention

Important Files Changed

File Analysis

Filename Score Overview
packages/docs/snippets/v3-banner.mdx 5/5 New reusable banner component created to help users discover Python/v2 docs from v3 pages
packages/docs/v3/first-steps/introduction.mdx 5/5 Added banner import and component to introduction page
packages/docs/v3/migrations/v2.mdx 5/5 Added banner to migration guide (ironically points users back to v2)
packages/docs/v2/best-practices/user-data.mdx 5/5 Added missing frontmatter metadata (title, sidebarTitle, description)
packages/docs/v3/best-practices/user-data.mdx 5/5 Added missing frontmatter metadata and banner component

Sequence Diagram

sequenceDiagram
    participant User
    participant V3Docs as v3 Documentation Page
    participant Banner as V3Banner Component
    participant V2Docs as v2 Documentation

    User->>V3Docs: Views any v3 docs page
    V3Docs->>Banner: Imports and renders V3Banner
    Banner->>User: Displays Python/v2 discovery banner
    User->>Banner: Clicks "Switch to v2 →"
    Banner->>V2Docs: Navigates to /v2/first-steps/introduction
    V2Docs->>User: Shows Python documentation
Loading

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.

53 files reviewed, no comments

Edit Code Review Agent Settings | Greptile

@seanmcguire12 seanmcguire12 merged commit 13c66dc into main Dec 8, 2025
4 checks 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