Skip to content

docs: mention compare API in examples guide#389

Open
kaizeenn wants to merge 1 commit into
aaronlab:mainfrom
kaizeenn:docs/issue-387-compare-api-examples
Open

docs: mention compare API in examples guide#389
kaizeenn wants to merge 1 commit into
aaronlab:mainfrom
kaizeenn:docs/issue-387-compare-api-examples

Conversation

@kaizeenn
Copy link
Copy Markdown
Contributor

Summary

  • add one sentence in examples/README.md clarifying when the local compare API is useful in addition to browsertrace compare ... --json
  • mention local scripts, dashboards, and automation checks that need the same first-divergence JSON payload while the local UI is running
  • extend metadata test assertions in tests/test_metadata.py to cover the new sentence

Linked issue

Verification

  • git diff --check
  • uv run --python 3.11 --extra dev pytest tests/test_metadata.py -q ⚠️ unavailable in this environment (uv: command not found)
  • python3 -m pytest tests/test_metadata.py -q ⚠️ unavailable in this environment (No module named pytest)

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Docs: mention compare API in examples guide

1 participant