Skip to content

docs: prefer PyPI install in user-facing install sections - #116

Merged
codeasier merged 1 commit into
mainfrom
issue-115-pypi-install-docs
Sep 7, 2026
Merged

codeasier merged 1 commit into
mainfrom
issue-115-pypi-install-docs

Conversation

@codeasier

Copy link
Copy Markdown
Owner

Summary

  • Lead README, quickstart, and MCP install sections with pip install pt-snap-cli so published users are not told to clone first.
  • Keep a contributor/source path via README Development and a short pip install -e ".[dev]" note in quickstart/MCP, with English and Chinese docs aligned.
  • Add a governance regression that the six user install docs document PyPI first and still mention a contributor path.

Test plan

  • pytest tests/test_governance.py
  • ruff check . and black --check .
  • Full pytest (769 passed; one preexisting environmental failure from ancestor .pt-snap/focus.json in the nested worktree)

Fixes #115

📝 Description

User-facing install docs still listed only pip install -e . after the package was published to PyPI. This PR makes PyPI the primary install command and leaves editable install as the contributor path.

🔗 Related Issue

Fixes #115

🧪 Testing

  • Tests added/updated
  • Manual testing completed

✅ Checklist

  • Code follows project guidelines
  • Documentation updated (if applicable)
  • No new warnings introduced
  • Changes tested locally

Snapshot Runtime Provenance

  • Snapshot provenance evaluation completed when snapshot runtime files change
    Snapshot provenance decision: no-update
    Snapshot provenance no-update reason: Documentation and governance test only; no snapshot runtime files change.

The published package is the normal user path; source checkout should stay a contributor option, not the only documented install.
@codeasier
codeasier merged commit 4aa93f2 into main Sep 7, 2026
6 checks passed
@codeasier
codeasier deleted the issue-115-pypi-install-docs branch October 3, 2026 19:18
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] 安装说明未包含 PyPI 发布版本,仍只提供源码安装方式

1 participant