Skip to content

docs: add PyPI install path to quick reference#186

Merged
imaurer merged 1 commit intomainfrom
align-quick-reference-install
Mar 10, 2026
Merged

docs: add PyPI install path to quick reference#186
imaurer merged 1 commit intomainfrom
align-quick-reference-install

Conversation

@imaurer
Copy link
Collaborator

@imaurer imaurer commented Mar 10, 2026

Summary

  • Adds a PyPI (recommended) install block to the quick reference ahead of the binary installer, so newcomers see both supported public install paths
  • Names the biomcp-cli package and biomcp command explicitly, matching the contract in the main installation guide
  • Adds a cross-link to the full installation page for source-build and platform-specific notes
  • Extends the public install docs contract test to assert both paths and the package/command naming contract

Test plan

  • Verify docs/reference/quick-reference.md shows PyPI block before binary installer block
  • Verify biomcp-cli is named as the package and biomcp as the command
  • Run uv run pytest tests/test_public_install_docs_contract.py -v — 3 tests pass
  • Run uv run pytest -q — full suite passes with no regressions

…t test

The quick reference install section previously showed only the binary
installer (curl), leaving newcomers unaware of the supported PyPI route.
Add a PyPI block (recommended) ahead of the binary installer block, name
the biomcp-cli package and biomcp command explicitly, and cross-link to
the full installation guide. Extend the public install docs contract test
to assert both paths and the package/command naming contract.
@imaurer imaurer merged commit 3d01fb9 into main Mar 10, 2026
1 check passed
@imaurer imaurer deleted the align-quick-reference-install branch March 10, 2026 18:54
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.

1 participant