Skip to content

Commit f35c4b6

Browse files
docs : update
1 parent 64da5fc commit f35c4b6

File tree

3 files changed

+60
-1
lines changed

3 files changed

+60
-1
lines changed

docs/docs.json

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -64,7 +64,7 @@
6464
"anchors": [
6565
{
6666
"anchor": "GitHub",
67-
"href": "https://github.com/auto-browse/auto-browse",
67+
"href": "https://github.com/auto-browse/auto-browse-ts",
6868
"icon": "github"
6969
},
7070
{

docs/installation.mdx

Lines changed: 36 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -29,6 +29,42 @@ Or using yarn:
2929
yarn add @auto-browse/auto-browse
3030
```
3131

32+
## ⚠️ Important: Playwright Version Requirements
33+
34+
Auto Browse currently requires specific versions of Playwright. This requirement will be relaxed in future versions.
35+
36+
### Required Versions
37+
38+
```bash
39+
"@playwright/test": "1.52.0-alpha-1743011787000"
40+
"playwright": "1.52.0-alpha-1743011787000"
41+
```
42+
43+
### Version Conflicts
44+
45+
If you're using Auto Browse alongside an existing Playwright setup, you must upgrade to these specific versions. Here's how to handle common issues:
46+
47+
1. **Installation Conflicts**
48+
49+
```bash
50+
npm install --legacy-peer-deps
51+
```
52+
53+
This flag helps resolve peer dependency conflicts during installation.
54+
55+
2. **Multiple Playwright Versions**
56+
57+
- Remove existing Playwright installations
58+
- Clear npm cache if needed: `npm cache clean --force`
59+
- Reinstall with the required versions
60+
61+
3. **Project Compatibility**
62+
- Update your project's Playwright configuration
63+
- Ensure your existing tests are compatible with the alpha version
64+
- Consider using a separate test environment if needed
65+
66+
> 🔄 Future releases will support a wider range of Playwright versions. Subscribe to our GitHub repository for updates.
67+
3268
## Environment Configuration
3369

3470
Auto-Browse requires configuration through environment variables for the Language Model (LLM) settings.

docs/usage/bdd-mode.mdx

Lines changed: 23 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -9,6 +9,29 @@ Auto-Browse seamlessly integrates with [playwright-bdd](https://github.com/vital
99

1010
## Setup
1111

12+
### ⚠️ Important: Playwright Version Requirements
13+
14+
When using Auto Browse with playwright-bdd, you must use specific Playwright versions for compatibility:
15+
16+
```bash
17+
"@playwright/test": "1.52.0-alpha-1743011787000"
18+
"playwright": "1.52.0-alpha-1743011787000"
19+
```
20+
21+
To handle version conflicts:
22+
23+
1. Remove any existing Playwright installations
24+
2. Clear npm cache if needed: `npm cache clean --force`
25+
3. Install dependencies with the legacy flag:
26+
27+
```bash
28+
npm install --legacy-peer-deps
29+
```
30+
31+
> 🔄 Future releases will support a wider range of Playwright versions.
32+
33+
### Installation
34+
1235
1. Install required dependencies:
1336

1437
```bash

0 commit comments

Comments
 (0)