Description
Webwright is powerful, but the current documentation feels hard to approach for first-time users.
Right now, users are exposed to:
- architecture details
- plugin systems (Claude Code / Codex)
- evaluation benchmarks
- internal design explanations
before getting a simple “run this in 5 minutes” path.
This makes it difficult to understand:
- how to start using Webwright quickly
- what the minimal working setup looks like
- what the expected output should be after installation
Problem
-
No clear “Quick Start” section at the top
-
Installation steps are scattered across multiple sections
-
First-time users may not know:
- what command to run first
- what success looks like
-
Docs mix research explanation + usage instructions, which increases cognitive load
Suggested improvement
Add a dedicated Quick Start (Minimal Example) section near the top:
It should include:
- 1 install command
- 1 example task run
- expected output (screenshots/logs or description)
Example structure:
- Install dependencies
- Run sample task
- View result folder / output
Why this matters
- Helps students / new contributors adopt faster
- Reduces setup confusion
- Improves repo accessibility without changing core design
- Makes the project more “plug-and-play”
Description
Webwright is powerful, but the current documentation feels hard to approach for first-time users.
Right now, users are exposed to:
before getting a simple “run this in 5 minutes” path.
This makes it difficult to understand:
Problem
No clear “Quick Start” section at the top
Installation steps are scattered across multiple sections
First-time users may not know:
Docs mix research explanation + usage instructions, which increases cognitive load
Suggested improvement
Add a dedicated Quick Start (Minimal Example) section near the top:
It should include:
Example structure:
Why this matters