microsoft / microsoft/Webwright

Improve onboarding clarity: missing quick-start path for new users

Open
#20 2 comments 2 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Dominant language
Python
Stars
6k
Forks
384
PR merge metrics
No merged PRs in 30d

Description

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”

Contributor guide

No contributing guide indexed for this repository

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Start by locating the current documentation and the scattered installation instructions, then identify where a Quick Start section fits near the top. Add one install command, one sample task, and a description of the expected output; the documentation is done when a first-time user can follow the path without relying on architecture or research details.

Written by the indexing model from the issue text.

Assessment

Domain
documentation
Issue type
Documentation
Difficulty
3/5
Estimated time
1-2 days
Activity status
Quiet
Clarity
Mostly clear
Newbie friendliness
55/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.