Skip to content

docs: fix START_HERE clawrtc install command#6520

Merged
Scottcjn merged 2 commits into
Scottcjn:mainfrom
Thanhdn1984:susan/fix-start-here-clawrtc-install
May 28, 2026
Merged

docs: fix START_HERE clawrtc install command#6520
Scottcjn merged 2 commits into
Scottcjn:mainfrom
Thanhdn1984:susan/fix-start-here-clawrtc-install

Conversation

@Thanhdn1984
Copy link
Copy Markdown
Contributor

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 bin entry, so it does not create a clawrtc command\n- adjust the management-command comment from "Cross-platform wrapper" to "PyPI wrapper"\n\n## Validation\n- npm view clawrtc bin scripts version --json returns only "1.6.0", confirming no npm bin entry is currently published\n- docs-only change; no runtime tests needed

@github-actions
Copy link
Copy Markdown
Contributor

Welcome to RustChain! Thanks for your first pull request.

Before we review, please make sure:

  • Non-doc PRs have a BCOS-L1 or BCOS-L2 label
  • Doc-only PRs are exempt from BCOS tier labels when they only touch docs/**, *.md, or common image/PDF files
  • New code files include an SPDX license header
  • You've tested your changes against the live node

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!

@github-actions github-actions Bot added documentation Improvements or additions to documentation size/XS PR: 1-10 lines labels May 28, 2026
Copy link
Copy Markdown
Contributor

@eliasx45 eliasx45 left a comment

Choose a reason for hiding this comment

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

Reviewed the START_HERE.md change.

Substantive observations:

  • The replacement from npm install -g clawrtc to python3 -m pip install --user clawrtc is consistent with the current npm metadata: npm view clawrtc bin scripts version --json returns only "1.6.0", so npm does not currently publish a bin mapping that would create a usable clawrtc command.
  • 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 clawrtc is 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.

@github-actions github-actions Bot added BCOS-L1 Beacon Certified Open Source tier BCOS-L1 (required for non-doc PRs) node Node server related size/S PR: 11-50 lines and removed BCOS-L1 Beacon Certified Open Source tier BCOS-L1 (required for non-doc PRs) size/XS PR: 1-10 lines node Node server related labels May 28, 2026
@Thanhdn1984
Copy link
Copy Markdown
Contributor Author

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.

Copy link
Copy Markdown
Contributor

@eliasx45 eliasx45 left a comment

Choose a reason for hiding this comment

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

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 --json returns 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 around except sqlite3.Error without 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 passed
  • git 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.

@Scottcjn Scottcjn merged commit 9e5f0c6 into Scottcjn:main May 28, 2026
10 of 11 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

documentation Improvements or additions to documentation size/S PR: 11-50 lines

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Bug: START_HERE recommends clawrtc npm CLI but package exposes no command

3 participants