Skip to content

Fix miner install docs to use installer script#6060

Open
Thanhdn1984 wants to merge 1 commit into
Scottcjn:mainfrom
Thanhdn1984:susan/fix-clawrtc-install-docs
Open

Fix miner install docs to use installer script#6060
Thanhdn1984 wants to merge 1 commit into
Scottcjn:mainfrom
Thanhdn1984:susan/fix-clawrtc-install-docs

Conversation

@Thanhdn1984
Copy link
Copy Markdown
Contributor

Fixes #5656.\n\nUpdates public install snippets that pointed users to pip install clawrtc for mining, which is not currently the working PyPI install path per the issue. Uses the documented installer script instead.\n\nVerification:\n- git diff --check passed.

@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 21, 2026
Copy link
Copy Markdown
Contributor

@hubeiqiao hubeiqiao left a comment

Choose a reason for hiding this comment

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

Thanks for fixing the stale PyPI install reference. The README and zh-CN README replacements look directionally correct to me, and the doc diff is whitespace-clean.

One blocker remains in docs/FAQ.md: the PR replaces the Windows section's pip install clawrtc line with a Unix shell command while leaving it inside a powershell fenced block and under the # 使用 Python 安装 comment:

# 使用 Python 安装
curl -fsSL https://rustchain.org/install.sh | bash

That command requires bash and is not a native PowerShell/Python install path, so Windows readers still get misleading installation instructions. Please either move the installer command into a bash/WSL/Linux/macOS snippet, or rewrite the Windows subsection to say WSL/Linux/macOS should use the installer script while native Windows mining/install support is not available or should use the documented alternative.

Validation I ran:

  • git diff --check origin/main...pr-6060 -- README.md docs/FAQ.md docs/zh-CN/README.md -> passed

Copy link
Copy Markdown
Contributor

@jaxint jaxint left a comment

Choose a reason for hiding this comment

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

LGTM! Great work on this PR. 🚀

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/XS PR: 1-10 lines

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Bug: pip-Installationsanleitung verweist auf nicht vorhandenes Paket

3 participants