docs: explain when the local compare API is better than CLI output#385
Conversation
The guide already showed the curl example for the local API endpoint but didn't say when to prefer it over the CLI. Added a sentence in the Compare section explaining the API is the right choice when a script, dashboard, or automation preflight check needs the first-divergence payload as JSON rather than terminal-formatted text. Updated test_browser_use_guide_documents_compare_run_metadata_checklist to assert the new sentence is present. Closes aaronlab#384
aaronlab
left a comment
There was a problem hiding this comment.
Thanks. You claimed #384 first, and this covers the requested Browser Use guide sentence plus metadata coverage.\n\nLocal verification after merging current into the PR branch:\n- ........................................................................ [ 17%]
........................................................................ [ 35%]
........................................................................ [ 53%]
........................................................................ [ 71%]
........................................................................ [ 89%]
......................................... [100%]
401 passed in 0.30s -> 401 passed\n- -> passed
aaronlab
left a comment
There was a problem hiding this comment.
Thanks. You claimed #384 first, and this covers the requested Browser Use guide sentence plus metadata coverage.
Local verification after merging current origin/main into the PR branch:
uv run --python 3.11 --extra dev pytest tests/test_metadata.py -q-> 401 passedgit diff --check origin/main...HEAD-> passed
Closes #384
Added a sentence in the Compare failed and successful Browser Use runs section explaining when to prefer the local API endpoint over
browsertrace compare:Also updated
test_browser_use_guide_documents_compare_run_metadata_checklistintests/test_metadata.pyto assert the new sentence is present.Verified: