Skip to content

Commit 6aade4f

Browse files
committed
docs: align support docs with public exports
1 parent 29cdfb8 commit 6aade4f

3 files changed

Lines changed: 8 additions & 3 deletions

File tree

CONTRIBUTING.md

Lines changed: 4 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -31,7 +31,7 @@ browser-agent failures instead of speculative APIs.
3131
```bash
3232
uv run --python 3.11 --extra dev pytest -q
3333
uv build
34-
python examples/no_api_failure_demo.py
34+
uv run --python 3.11 python -m browsertrace.cli demo
3535
browsertrace
3636
```
3737

@@ -72,4 +72,6 @@ For each PR, include:
7272
- What user problem it solves.
7373
- How to try it locally.
7474
- Test commands run.
75-
- Screenshots or exported traces for UI/demo changes.
75+
- Screenshots or exported traces for UI/demo changes. Use
76+
`browsertrace export <run_id> --public -o public.html` before attaching a
77+
real trace publicly.

SECURITY.md

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -32,6 +32,7 @@ Include:
3232
`BROWSERTRACE_HOME`.
3333
- HTML exports inline screenshots and model output. Review exports before
3434
sharing them publicly.
35+
- Use `browsertrace export <run_id> --public -o public.html` before public
36+
sharing to omit prompt/model I/O, screenshots, and URLs.
3537
- Do not attach trace exports containing secrets, customer data, private URLs,
3638
cookies, tokens, or proprietary prompts to public issues.
37-

SUPPORT.md

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -29,6 +29,8 @@ Please include:
2929
- Agent/browser stack.
3030
- Reproduction steps.
3131
- Exported trace or `browsertrace show <id>` output if it is safe to share.
32+
Use `browsertrace export <run_id> --public -o public.html` before attaching a
33+
real trace publicly.
3234

3335
## Feature and Integration Requests
3436

0 commit comments

Comments
 (0)