Skip to content

Docs: link comparison guide from examples guide #341

@aaronlab

Description

@aaronlab

Context

Traffic from good-first-issue directories is reaching the repo, and the current queue should have a small number of non-duplicative docs tasks for first-time contributors.

examples/README.md already links stack-specific debugging guides, but it does not point readers to the comparison page that explains when BrowserTrace is useful alongside Playwright Trace Viewer, LangSmith, Langfuse, and Browserbase-style browser tracing.

Task

Add one concise link to the comparison page in examples/README.md, near the ### Stack-specific debugging guides section or the nearby guide-selection notes.

Suggested link target:

https://aaronlab.github.io/browsertrace/compare-browser-agent-debugging.html

Keep the change narrow:

  • Do not rewrite the examples guide.
  • Do not change generated HTML files.
  • Add only one short sentence or one bullet.
  • Keep the existing stack-specific guide links intact.

Verification

Run:

git diff --check

If you also run tests, this docs-only check is enough:

uv run --python 3.11 --extra dev pytest tests/test_metadata.py -q

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