Skip to content

Commit 4722130

Browse files
[docs] fix github links (#1202)
# why - we had some broken github links in the docs since merging v3 and refactoring the pnpm workspace/repo structure # what changed - fixed the broken links
1 parent 0a5ee63 commit 4722130

File tree

7 files changed

+9
-9
lines changed

7 files changed

+9
-9
lines changed

packages/docs/v2/best-practices/contributing.mdx

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -44,8 +44,8 @@ Get listed as [one of our beloved contributors](https://github.com/browserbase/s
4444
![Draft PR](/images/pr_draft.png)
4545

4646
2. **Provide a reproducible test plan.** Include an eval (preferred) or example. We can’t merge your PR if we can’t run anything that specifically highlights your contribution.
47-
1. Write a script in [`evals/tasks`](https://github.com/browserbase/stagehand/tree/main/evals/tasks) as `someTask.ts`
48-
2. Add your script to [`evals.config.json`](https://github.com/browserbase/stagehand/blob/main/evals/evals.config.json) with default category `combination` (*or act/extract/observe if you’re* *only* *testing* *act/extract/observe*).
47+
1. Write a script in [`evals/tasks`](https://github.com/browserbase/stagehand/tree/v2/evals/tasks) as `someTask.ts`
48+
2. Add your script to [`evals.config.json`](https://github.com/browserbase/stagehand/blob/v2/evals/evals.config.json) with default category `combination` (*or act/extract/observe if you’re* *only* *testing* *act/extract/observe*).
4949
3. **Add a changeset.** Run `npx changeset` in TS or `uvx changeset` in Python to add a changeset that will directly reflect in the `CHANGELOG` in the upcoming release.
5050
1. `patch` - no net new functionality to an end-user
5151
2. `minor` - some net new functionality to an end-user (new function parameter, new exposed type, etc.)

packages/docs/v2/configuration/evals.mdx

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -132,7 +132,7 @@ evals run b:osworld -f source=Mind2Web
132132

133133
#### Configuration Files
134134

135-
You can view the specific evals in [`evals/tasks`](https://github.com/browserbase/stagehand/tree/main/evals/tasks). Each eval is grouped into eval categories based on [`evals/evals.config.json`](https://github.com/browserbase/stagehand/blob/main/evals/evals.config.json).
135+
You can view the specific evals in [`evals/tasks`](https://github.com/browserbase/stagehand/tree/v2/evals/tasks). Each eval is grouped into eval categories based on [`evals/evals.config.json`](https://github.com/browserbase/stagehand/blob/main/evals/evals.config.json).
136136

137137

138138
#### Viewing eval results
@@ -148,7 +148,7 @@ You can use the Braintrust UI to filter by model/eval and aggregate results acro
148148

149149
To run deterministic evals, you can run `npm run e2e` from within the Stagehand repo. This will test the functionality of Playwright within Stagehand to make sure it's working as expected.
150150

151-
These tests are in [`evals/deterministic`](https://github.com/browserbase/stagehand/tree/main/evals/deterministic) and test on both Browserbase browsers and local headless Chromium browsers.
151+
These tests are in [`evals/deterministic`](https://github.com/browserbase/stagehand/tree/v2/evals/deterministic) and test on both Browserbase browsers and local headless Chromium browsers.
152152

153153
## Creating Custom Evaluations
154154

packages/docs/v2/configuration/models.mdx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -168,7 +168,7 @@ Vercel AI SDK supports providers for OpenAI, Anthropic, and Google, along with s
168168

169169
To get started, you'll need to install the `ai` package and the provider you want to use. For example, to use Amazon Bedrock, you'll need to install the `@ai-sdk/amazon-bedrock` package.
170170

171-
You'll also need to use the [Vercel AI SDK external client](https://github.com/browserbase/stagehand/blob/main/examples/external_clients/aisdk.ts) as a template to create a client for your model.
171+
You'll also need to use the [Vercel AI SDK external client](https://github.com/browserbase/stagehand/blob/v2/examples/external_clients/aisdk.ts) as a template to create a client for your model.
172172

173173
<Tabs>
174174
<Tab title="npm">

packages/docs/v2/first-steps/introduction.mdx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -124,7 +124,7 @@ Stagehand is designed for developers building production browser automations and
124124
<Card
125125
title="View Examples"
126126
icon="code"
127-
href="https://github.com/browserbase/stagehand/tree/main/examples"
127+
href="https://github.com/browserbase/stagehand/tree/v2/examples"
128128
>
129129
See real-world automation examples
130130
</Card>

packages/docs/v2/references/stagehand.mdx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -128,7 +128,7 @@ await stagehand.init()
128128
<ParamField path="localBrowserLaunchOptions" type="LocalBrowserLaunchOptions" optional>
129129
Configuration options for launching a local browser. Only used when `env` is `LOCAL`.
130130

131-
See the [full interface definition](https://github.com/browserbase/stagehand/blob/main/types/stagehand.ts#L174) for all available options.
131+
See the [full interface definition](https://github.com/browserbase/stagehand/blob/v2/types/stagehand.ts#L174) for all available options.
132132
</ParamField>
133133

134134
#### LLM Configuration

packages/docs/v3/basics/evals.mdx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -127,7 +127,7 @@ evals run b:osworld -f source=Mind2Web
127127

128128
#### Configuration Files
129129

130-
You can view the specific evals in [`evals/tasks`](https://github.com/browserbase/stagehand/tree/main/evals/tasks). Each eval is grouped into eval categories based on [`evals/evals.config.json`](https://github.com/browserbase/stagehand/blob/main/evals/evals.config.json).
130+
You can view the specific evals in [`evals/tasks`](https://github.com/browserbase/stagehand/tree/main/packages/evals/tasks). Each eval is grouped into eval categories based on [`evals/evals.config.json`](https://github.com/browserbase/stagehand/blob/main/evals/evals.config.json).
131131

132132

133133
#### Viewing eval results

packages/docs/v3/first-steps/introduction.mdx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -99,7 +99,7 @@ Stagehand is designed for developers building production browser automations and
9999
<Card
100100
title="View Examples"
101101
icon="code"
102-
href="https://github.com/browserbase/stagehand/tree/main/examples"
102+
href="https://github.com/browserbase/stagehand/tree/main/packages/core/examples"
103103
>
104104
See real-world automation examples
105105
</Card>

0 commit comments

Comments
 (0)