Context
BrowserTrace already supports public-safe HTML exports with:
browsertrace export <run_id> --public -o public.html
The README and launch docs mention this, but a first-time contributor could make the workflow clearer by adding one small, copyable sharing example for bug reports or feedback threads.
Task
Add a short docs example to README.md or examples/README.md showing how to create and share a public-safe export after running the demo. Keep it concise and focused on safe sharing.
Suggested points to cover:
- Run the demo first if needed.
- Use
browsertrace list to find the run ID.
- Run
browsertrace export <run_id> --public -o public.html.
- Mention that
--public omits prompts/model I/O, screenshots, and URLs.
- Do not include private prompts, credentials, cookies, tokens, customer data, or private screenshots in docs/examples.
Acceptance criteria
- The docs contain a copyable public-safe export example.
- The example does not imply hosted sharing exists yet.
- Existing GitHub-tag install and
uvx commands stay on v0.1.13 while PyPI is pending.
- Run
uv run --python 3.11 --extra dev pytest -q before opening a PR.
Context
BrowserTrace already supports public-safe HTML exports with:
The README and launch docs mention this, but a first-time contributor could make the workflow clearer by adding one small, copyable sharing example for bug reports or feedback threads.
Task
Add a short docs example to
README.mdorexamples/README.mdshowing how to create and share a public-safe export after running the demo. Keep it concise and focused on safe sharing.Suggested points to cover:
browsertrace listto find the run ID.browsertrace export <run_id> --public -o public.html.--publicomits prompts/model I/O, screenshots, and URLs.Acceptance criteria
uvxcommands stay onv0.1.13while PyPI is pending.uv run --python 3.11 --extra dev pytest -qbefore opening a PR.