docs(#248): add environment variable example values#250
Merged
aaronlab merged 1 commit intoMay 11, 2026
Merged
Conversation
aaronlab
approved these changes
May 11, 2026
aaronlab
left a comment
Owner
There was a problem hiding this comment.
Thanks, this is exactly the small docs-only update requested in #248. I verified the diff locally with and ........................................................................ [ 28%]
........................................................................ [ 56%]
........................................................................ [ 84%]
....................................... [100%]
255 passed in 0.17s, and CI is green.
Owner
|
Clarifying my approval note: local verification was: git diff --check origin/main...HEAD
uv run --python 3.11 --extra dev pytest tests/test_metadata.py -qThe metadata test run passed with 255 tests, and the PR remains docs-only in |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
Fixes #248 by adding concrete example values for the two environment variables in
examples/README.md.BROWSERTRACE_HOME=/tmp/browsertrace-demoas a copy-paste value for isolated local tracesBROWSERTRACE_PORT=4000as a copy-paste value when port3000is busyVerification
I ran the lightweight docs checks called out in the issue:
Notes
examples/README.md.uvwas not available in this environment, so I used the closest local fallback check requested by the issue.