Skip to content

docs: merge duplicate ui install bullets in readme#338

Merged
aaronlab merged 1 commit into
aaronlab:mainfrom
dimasd-angga:fix/issue-337-docs-merge-duplicate-readme-ui-extra-bul
May 12, 2026
Merged

docs: merge duplicate ui install bullets in readme#338
aaronlab merged 1 commit into
aaronlab:mainfrom
dimasd-angga:fix/issue-337-docs-merge-duplicate-readme-ui-extra-bul

Conversation

@dimasd-angga

Copy link
Copy Markdown
Contributor

Summary

The Install From PyPI useful-checks list had two adjacent bullets covering the [ui] vs SDK-only distinction, which overlapped in meaning and made the list feel redundant. This collapses them into a single bullet that keeps both the UI-vs-SDK framing and the terminal-command note, matching the maintainer's ask for a focused PR that removes the duplicate pip install "browsertrace[ui]" bullet without changing the surrounding README wording.

Changes

  • README.md: replace the two adjacent [ui]/SDK-only bullets in the Install From PyPI useful-checks list with one merged bullet preserving both meanings (local web UI requires [ui]; SDK-only install is enough for trace capture and still supports browsertrace list, browsertrace show, and browsertrace export).
  • tests/test_metadata.py: update the bulleted-tip assertion list in test_readme_groups_install_tips_as_compact_list to expect the single merged bullet instead of the two original lines.

Testing

  • uv run --python 3.11 --extra dev pytest tests/test_metadata.py -q — passes.

Notes

The two README bullets are merged into one rather than dropping a meaning, so both the UI requirement and the SDK-only terminal-command note are still discoverable in the same list. No other README content, install commands, or links are touched.

Closes #337

The two adjacent `[ui]`/SDK-only bullets in the Install From PyPI useful-checks list overlapped in meaning, making the list feel redundant. Combining them into one bullet keeps both the UI-vs-SDK distinction and the terminal-command note without repeating the same framing twice.

@aaronlab aaronlab left a comment

Copy link
Copy Markdown
Owner

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks, this is focused and keeps the install-path meaning intact. I verified uv run --python 3.11 --extra dev pytest tests/test_metadata.py -q locally and git diff --check is clean.

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: merge duplicate README UI extra bullets

2 participants