Skip to content

Docs: add expected-output notes for no-service examples #234

@aaronlab

Description

@aaronlab

Context

examples/README.md has a useful example matrix and no-service commands, but a first-time contributor or user does not get a compact picture of what a successful no-service example run should look like before opening the UI. A short expected-output note would make the examples easier to verify locally and gives a newcomer a narrow docs-only contribution.

Suggested scope

Update examples/README.md only. Add a concise expected-output note for one or more no-service examples, such as:

  • python examples/stagehand_wrapper_example.py
  • python examples/skyvern_wrapper_example.py
  • python examples/playwright_llm_loop_example.py
  • python examples/computer_use_loop_example.py

The note should show the verification commands rather than large copied output. For example, point readers to run:

python examples/stagehand_wrapper_example.py
browsertrace list --limit 5
browsertrace show <run_id>

and mention the kind of run/action names they should expect to see.

Acceptance criteria

Verification

A good PR can report:

uv run --python 3.11 --extra dev pytest tests/test_metadata.py -q
python examples/stagehand_wrapper_example.py
browsertrace list --limit 5

If you choose a different no-service example, include the equivalent command you ran.

No stars, votes, reposts, or reciprocal promotion are requested; this is only a small documentation improvement for local verification.

Metadata

Metadata

Assignees

No one assigned

    Labels

    claimedContributor has said they are working on thisdocumentationImprovements or additions to documentationgood first issueGood for newcomershelp wantedExtra attention is needed

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions