Update mining docs: maintained p2pool-dash fork, its install guide, and current ASIC hardware - #587
Update mining docs: maintained p2pool-dash fork, its install guide, and current ASIC hardware#587frstrtr wants to merge 6 commits into
Conversation
|
No actionable comments were generated in the recent review. 🎉 ℹ️ Recent review info⚙️ Run configurationConfiguration used: Path: .coderabbit.yaml Review profile: CHILL Plan: Pro Plus Run ID: 📒 Files selected for processing (2)
🚧 Files skipped from review as they are similar to previous changes (2)
📝 WalkthroughWalkthroughThe mining documentation now references the maintained ChangesMining Documentation
Estimated code review effort: 1 (Trivial) | ~3 minutes 🚥 Pre-merge checks | ✅ 5✅ Passed checks (5 passed)
Comment |
There was a problem hiding this comment.
Actionable comments posted: 2
🤖 Prompt for all review comments with AI agents
Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.
Inline comments:
In `@docs/user/mining/index.rst`:
- Around line 135-136: Update the Bitmain Antminer D9 row in the mining hardware
table to use the unboxed dimensions 430 x 195.5 x 290 mm, or explicitly label
the existing 316 x 430 x 570 value as packaged dimensions; keep the net weight
unchanged.
In `@docs/user/mining/p2pool.rst`:
- Around line 22-24: Update the modern installation guidance in the surrounding
p2pool documentation to link to the maintained frstrtr/p2pool-dash README
instead of INSTALL.md until INSTALL.md is corrected. Also label the retained
python2 commands near the referenced installation steps as applicable only to
Ubuntu 20.04 and earlier, or replace them with the fork’s PyPy-based commands.
🪄 Autofix
Fix all unresolved CodeRabbit comments on this PR:
- Push a commit to this branch (recommended)
- Create a new PR with the fixes
ℹ️ Review info
⚙️ Run configuration
Configuration used: Path: .coderabbit.yaml
Review profile: CHILL
Plan: Pro Plus
Run ID: 0c8fb25a-e4af-4f5d-b2fb-2d221cde0f73
📒 Files selected for processing (3)
docs/user/mining/index.rstdocs/user/mining/p2pool.rstdocs/user/mining/pools.rst
| <https://github.com/frstrtr/p2pool-dash>`_ software on GitHub, which is | ||
| a fork of p2pool for Bitcoin. For more information, see `here | ||
| <https://en.bitcoin.it/wiki/P2Pool>`__. | ||
| <https://en.bitcoin.it/wiki/P2Pool>`__. The original ``dashpay/p2pool-dash`` repository has not been updated since May 2023 (Dash Core v18 era); ``frstrtr/p2pool-dash`` is an actively maintained continuation supporting current Dash Core releases. An experimental modern alternative is `c2pool <https://github.com/frstrtr/c2pool>`_, a from-scratch C++ reimplementation whose Dash support is daemonless (no Dash Core node required) but, per the project's own status, still in development. On modern Ubuntu/Debian (24.04+, where Python 2 is no longer packaged), follow the fork's own installation guide `INSTALL.md <https://github.com/frstrtr/p2pool-dash/blob/master/INSTALL.md>`_, which uses PyPy and provides an automated Ubuntu 24.04 installer script. |
There was a problem hiding this comment.
🎯 Functional Correctness | 🟠 Major | ⚡ Quick win
🧩 Analysis chain
🏁 Script executed:
#!/bin/sh
set -eu
body="$(curl -fsSL https://raw.githubusercontent.com/frstrtr/p2pool-dash/master/INSTALL.md)"
if printf '%s\n' "$body" | grep -Fq 'git clone https://github.com/dashpay/p2pool-dash.git'; then
echo "INSTALL.md still points to the stale dashpay repository" >&2
exit 1
fiRepository: dashpay/docs
Length of output: 206
🏁 Script executed:
#!/bin/sh
set -eu
file="docs/user/mining/p2pool.rst"
printf '%s\n' '--- documentation lines ---'
sed -n '1,35p;190,235p' "$file"
printf '%s\n' '--- repository references ---'
rg -n -F 'p2pool-dash' "$file"
printf '%s\n' '--- external installation guidance ---'
curl -fsSL https://raw.githubusercontent.com/frstrtr/p2pool-dash/master/INSTALL.md |
grep -nE 'git clone|python2|PyPy|pypy|Ubuntu|install' | head -80
printf '%s\n' '--- external README guidance ---'
curl -fsSL https://raw.githubusercontent.com/frstrtr/p2pool-dash/master/README.md |
grep -nE 'git clone|python2|PyPy|pypy|Ubuntu|install' | head -80Repository: dashpay/docs
Length of output: 9382
Make the modern installation path self-consistent before merging.
INSTALL.md still clones dashpay/p2pool-dash, while the maintained fork and its README use frstrtr/p2pool-dash. Link to the README until INSTALL.md uses the maintained fork. Label the retained python2 commands at Lines 200–203, 211, and 226 as an Ubuntu 20.04-and-earlier procedure, or replace them with PyPy commands.
🤖 Prompt for AI Agents
Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.
In `@docs/user/mining/p2pool.rst` around lines 22 - 24, Update the modern
installation guidance in the surrounding p2pool documentation to link to the
maintained frstrtr/p2pool-dash README instead of INSTALL.md until INSTALL.md is
corrected. Also label the retained python2 commands near the referenced
installation steps as applicable only to Ubuntu 20.04 and earlier, or replace
them with the fork’s PyPy-based commands.
Source: MCP tools
…repo The install guide still cloned dashpay/p2pool-dash (unmaintained since May 2023) and pointed issues there. Point both at frstrtr/p2pool-dash so the modern install path is self-consistent with the fork and its README (flagged on dashpay/docs#587).
… label - Antminer D9: use unboxed dimensions 430 x 195.5 x 290 mm (was the packaged size reordered) so they are consistent with the 16.1 kg net weight; widen the Dimensions column to fit. - p2pool.rst: label the inline P2Pool setup as the legacy Python 2 procedure (Ubuntu 20.04 LTS and earlier); direct 24.04+ users to the fork PyPy INSTALL.md.
|
Thanks @coderabbitai — addressed both:
|
|
Tip For best results, initiate chat on the files or code changes.
The Antminer D9 dimensions now match the listed net weight. The P2Pool documentation now separates the legacy Python 2 procedure from the current PyPy-based installation path. 🐇 ✏️ Learnings added
You are interacting with an AI system. |
The two mining pages linked https://github.com/dashpay/p2pool-dash, which has not been updated since
30 May 2023 (Dash Core v0.12–v18 era, Python 2.7 only) and no longer works cleanly against current Dash Core.
This PR:
docs/user/mining/p2pool.rst,pools.rst,index.rst) tohttps://github.com/frstrtr/p2pool-dash — an actively maintained continuation supporting current Dash Core
(v23+, protocol 70238+), with variable difficulty, extranonce rolling, a persistent share/block archive,
and an updated dashboard. It runs on Python 2.7 via PyPy and ships an automated Ubuntu 24.04 installer.
INSTALL.mdfor modern Ubuntu/Debian, where Python 2 is no longer packaged.reimplementation whose Dash support is daemonless (no Dash Core node required) and, per that project's own
status table, still in development.
The change is a minimal, factual link correction plus one hedged note and one hardware row; the install
walkthroughs are otherwise unchanged so the diff is easy to review. Built locally with
make html— thethree edited pages render without errors.
Preview build: https://dash-docs--587.org.readthedocs.build/en/587/
Summary by CodeRabbit