Skip to content

Docs: add environment variable example values #248

@aaronlab

Description

@aaronlab

Goal

Add a tiny expected-values note under the Environment variable quick reference section in examples/README.md so first-time users know what values to use when they want isolated trace storage or a non-default UI port.

Scope

Keep this docs-only and edit only:

  • examples/README.md

Suggested location: directly below the environment variable quick reference table.

Suggested change

Add one or two short sentences showing practical values, for example:

  • BROWSERTRACE_HOME=/tmp/browsertrace-demo for an isolated local demo store.
  • BROWSERTRACE_PORT=4000 when port 3000 is already in use.

Keep the existing Windows PowerShell examples in the troubleshooting sections unchanged unless you only need to reference them.

Acceptance criteria

  • The note mentions both BROWSERTRACE_HOME and BROWSERTRACE_PORT.
  • It keeps the wording concise and beginner-friendly.
  • It does not change code, examples, or generated assets.
  • It does not ask for stars, upvotes, reposts, or promotion.

Verification

Please include the exact commands you ran. For a docs-only change, this is enough:

git diff --check
uv run --python 3.11 --extra dev pytest tests/test_metadata.py -q

If uv is not available in your environment, say that in the PR and run the closest local docs check you can.

Metadata

Metadata

Assignees

No one assigned

    Labels

    claimedContributor has said they are working on thisdocumentationImprovements or additions to documentationgood first issueGood for newcomershelp wantedExtra attention is needed

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions