docs: fix START_HERE clawrtc install command#6520
Conversation
|
Welcome to RustChain! Thanks for your first pull request. Before we review, please make sure:
Bounty tiers: Micro (1-10 RTC) | Standard (20-50) | Major (75-100) | Critical (100-150) A maintainer will review your PR soon. Thanks for contributing! |
eliasx45
left a comment
There was a problem hiding this comment.
Reviewed the START_HERE.md change.
Substantive observations:
- The replacement from
npm install -g clawrtctopython3 -m pip install --user clawrtcis consistent with the current npm metadata:npm view clawrtc bin scripts version --jsonreturns only"1.6.0", so npm does not currently publish abinmapping that would create a usableclawrtccommand. - The added note is useful because it explains the failure mode directly instead of only swapping commands. That should prevent users from repeating the global npm install and then being confused when
clawrtcis unavailable on PATH. - The management section label change from ?Cross-platform wrapper? to ?PyPI wrapper? keeps the docs honest for the current install path. Longer term, if npm packaging is restored, this section may need to become ?CLI wrapper? again with separate npm/PyPI install options.
Validation performed:
npm view clawrtc bin scripts version --json
# "1.6.0"
No blocking issues found in this docs-only patch.
|
CI note: the blocking pytest job is failing in unrelated application tests (auth/API/wallet/UTXO), while this PR is docs-only and only changes START_HERE.md. I checked the failure log after the latest push; no failure references START_HERE.md or the clawrtc install text changed here. |
eliasx45
left a comment
There was a problem hiding this comment.
Re-reviewed the updated head 9eb1c77fc4f9dc8fa0ffaa6a4eca8e546e12c5a4 since this PR now includes both the START_HERE docs change and a node/gpu_render_endpoints.py syntax fix.
No blockers found.
What changed since my earlier docs-only review:
- The START_HERE change still matches current package metadata:
npm view clawrtc bin scripts version --jsonreturns only"1.6.0", so the PyPI install path is the honest current recommendation. - The new GPU commit keeps the escrow credit/update block inside the
try:body, resolving the syntax failure aroundexcept sqlite3.Errorwithout changing the release authorization checks. - The focused GPU security route tests pass on this head.
Validation performed locally:
npm view clawrtc bin scripts version --json->"1.6.0".\.venv\Scripts\python.exe -m py_compile node\gpu_render_endpoints.py-> passed.\.venv\Scripts\python.exe -m pytest tests\test_gpu_render_endpoints_security.py -q-> 11 passedgit diff --check origin/main...HEAD-> clean
Non-blocking note: the PR title/body still describe a docs-only START_HERE change, but the branch now also carries the GPU syntax fix. Updating the PR summary before merge would make the merge history clearer.
I received RTC compensation for this review.
Fixes #6515.\n\n## Summary\n- replace the START_HERE npm global install command with the PyPI install path used elsewhere in the docs\n- add a short note explaining that the current npm package has no
binentry, so it does not create aclawrtccommand\n- adjust the management-command comment from "Cross-platform wrapper" to "PyPI wrapper"\n\n## Validation\n-npm view clawrtc bin scripts version --jsonreturns only"1.6.0", confirming no npmbinentry is currently published\n- docs-only change; no runtime tests needed