Fix miner install docs to use installer script#6060
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! |
hubeiqiao
left a comment
There was a problem hiding this comment.
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 | bashThat 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
jaxint
left a comment
There was a problem hiding this comment.
LGTM! Great work on this PR. 🚀
Fixes #5656.\n\nUpdates public install snippets that pointed users to
pip install clawrtcfor mining, which is not currently the working PyPI install path per the issue. Uses the documented installer script instead.\n\nVerification:\n-git diff --checkpassed.