-
Notifications
You must be signed in to change notification settings - Fork 1.3k
Fix broken link to quickstart in the README #1207
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
Conversation
🦋 Changeset detectedLatest commit: 84cdaf9 The changes in this PR will be included in the next version bump. This PR includes changesets to release 2 packages
Not sure what this means? Click here to learn what changesets are. Click here if you're a maintainer who wants to add another changeset to this PR |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Greptile Overview
Greptile Summary
Fixed broken quickstart documentation links across README files. The links were updated from the old path (docs.stagehand.dev/get_started/quickstart) to the current v3 documentation structure (docs.stagehand.dev/v3/first-steps/quickstart).
- Updated root
README.mdwith correct quickstart link - Updated
packages/core/README.mdto match - Added proper changeset for the patch release
Confidence Score: 5/5
- This PR is safe to merge with zero risk
- The changes are limited to documentation link updates only - no code logic, no syntax changes, just URL path corrections. The changeset is properly formatted and the links follow the correct v3 documentation structure.
- No files require special attention
Important Files Changed
File Analysis
| Filename | Score | Overview |
|---|---|---|
| .changeset/brave-mangos-reply.md | 5/5 | Added changeset documenting the quickstart link fix |
| README.md | 5/5 | Updated quickstart link from old path to v3 documentation structure |
| packages/core/README.md | 5/5 | Updated quickstart link to match root README changes |
Sequence Diagram
sequenceDiagram
participant Dev as Developer
participant Repo as Repository
participant Docs as Documentation Site
Dev->>Repo: Identify broken link
Note over Dev,Repo: Old path: /get_started/quickstart
Dev->>Repo: Update README.md
Dev->>Repo: Update packages/core/README.md
Dev->>Repo: Add changeset file
Note over Dev,Repo: New path: /v3/first-steps/quickstart
Repo->>Docs: Users now directed to correct page
Docs-->>Repo: Valid quickstart guide
2 files reviewed, no comments
This PR was opened by the [Changesets release](https://github.com/changesets/action) GitHub action. When you're ready to do a release, you can merge this and the packages will be published to npm automatically. If you're not ready to do a release yet, that's fine, whenever you add more changesets to main, this PR will be updated. # Releases ## @browserbasehq/stagehand@3.0.1 ### Patch Changes - [#1207](#1207) [`55da8c6`](55da8c6) Thanks [@miguelg719](https://github.com/miguelg719)! - Fix broken links to quickstart docs - [#1200](#1200) [`0a5ee63`](0a5ee63) Thanks [@seanmcguire12](https://github.com/seanmcguire12)! - log info when scope narrowing selector fails - [#1205](#1205) [`ee76881`](ee76881) Thanks [@miguelg719](https://github.com/miguelg719)! - Update README.md, add Changelog for v3 - [#1209](#1209) [`9e95add`](9e95add) Thanks [@seanmcguire12](https://github.com/seanmcguire12)! - fix circular import in exported aisdk example client - [#1211](#1211) [`98e212b`](98e212b) Thanks [@miguelg719](https://github.com/miguelg719)! - Add an example for passing custom tools to agent - [#1206](#1206) [`d5ecbfc`](d5ecbfc) Thanks [@miguelg719](https://github.com/miguelg719)! - Export example AISdkClient properly from the stagehand package ## @browserbasehq/stagehand-evals@1.1.1 ### Patch Changes - Updated dependencies \[[`55da8c6`](55da8c6), [`0a5ee63`](0a5ee63), [`ee76881`](ee76881), [`9e95add`](9e95add), [`98e212b`](98e212b), [`d5ecbfc`](d5ecbfc)]: - @browserbasehq/stagehand@3.0.1 Co-authored-by: github-actions[bot] <41898282+github-actions[bot]@users.noreply.github.com>
why
Link points to the old docs route
what changed
Fixed link to the Quickstart section of the docs on the readme
Shoutout to @JerryWu1234 for the contrib
test plan