Skip to content

Docs: add public-safe export verification note #242

@aaronlab

Description

@aaronlab

Goal

Add a small expected-output / verification note for the public-safe export recipe in examples/README.md.

Scope

Please keep this docs-only and limited to examples/README.md unless you find an existing command in that file is wrong.

A good target section is:

  • ## Public Export Flow
  • or ### Creating a Share-Safe Export

Add 2-4 sentences that tell a first-time user how to verify the public-safe export worked. For example, after running:

browsertrace demo
browsertrace list
browsertrace export <run_id> --public -o public.html

readers should know that:

  • public.html should be created in the current directory.
  • opening it should show the run timeline / status / errors.
  • prompts/model I/O, screenshots, and URLs should be omitted from the public export.
  • if export reports an ambiguous run ID prefix, they should copy more characters from the full Run ID: printed by browsertrace demo.

Verification

Please include the exact commands you ran in the PR. A good local check is:

browsertrace demo
browsertrace list --limit 5
browsertrace export <run_id> --public -o public.html

Optional docs check:

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

Non-goals

  • Do not change the export implementation.
  • Do not add screenshots or generated HTML files to the repository.
  • Do not update release assets.

Metadata

Metadata

Assignees

No one assigned

    Labels

    documentationImprovements 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