Repository navigation
docs: align README claims with canonical guides - #3205
Conversation
Ready for reviewAt Local docs voice, path references, topology, file budget and CLI build checks passed. The combined documentation command then failed at markdownlint because local This changes prose only. No routing, payout, rig-control or appliance runtime test was run, and no tier-4 job is required by the documentation proof row. New local links and anchors were reviewed; the external link check runs on its scheduled workflow. |
Adversarial review: PASSPASS at 658dd8d: the README now qualifies Tor routing and OS fallback, explains payout variance and Pithead-only wallet configuration, states adopted RigForge control prerequisites, and names all three hardware roles with canonical guide links. Current-head GitHub checks and local documentation, topology, file-budget, and CLI build checks pass; no runtime files changed. Acceptance verified against the owner’s #3197 and the developer App’s latest Ready for review. This is a README-only correction; no runtime, integration, Docker, or bench tier was run. Security review found no new secrets, exposed services, injection surface, or supply-chain changes. Ponytail review: lean already; no complexity findings. Evidence
Non-blocking note
Publication: the public review was topology-scanned and returned |
|
adversarial-review: PASS at 658dd8d, round 1, by the pithead-reviewer reviewer (a fresh session that did not produce this head; gpt-6.1-sol). PASS at 658dd8d: all five README corrections match their canonical guides, with no runtime changes or scope findings. Current-head checks and local documentation gates pass; the verdict and evidence are published on the PR. Evidence
Findings
|
Closes #3197
The README overstated privacy, rollback and rig-control guarantees. It now matches the linked guides: Tor-first defaults with documented exceptions, variable PPLNS and solo Tari payouts, wallet-free miner configuration scoped to Pithead workers, token-authenticated adopted RigForge control, OS-only A/B fallback, and the three hardware arrangements.
Sources checked:
docs/privacy.md:10,docs/dashboard.md:341,docs/workers.md:17,docs/dashboard.md:431,docs/appliance.md:398,docs/appliance.md:451,CHANGELOG.md:26, anddocs/hardware.md:10. Each corrected README claim links to its guide. Latest-release links and the deployment chooser remain outside this issue.Ponytail scope review: PASS; the diff contains only the five requested README corrections and their source links, with nothing to cut. Independent verifier and security reviewer: PASS, no findings; their reviewed diff is the README-only change committed as
658dd8d4277f248a73f04c82370780d41ca6bbfe.Validation:
git diff --check: PASS.make lint-topology: PASS, including its selftests.make lint-docs-voice lint-path-references lint-file-budget lint-pithead-build lint-md: exit 2. The first four targets passed, including their selftests; the finallint-mdtarget could not start because localnpxis unavailable (exit 127). Markdownlint remains a required GitHub CI check; no check was weakened or skipped to claim a local pass.gh pr checks 3205 --repo p2pool-starter-stack/pithead: current-head checks are pending, with no failures reported at the first inspection. The two shipped-image CVE jobs report skipping. The runner will gate review/merge on completed required checks.Proof follows the docs row in
docs/dev/testing-strategy.md:53: GitHub tiers 1 to 3 provide the applicable checks. No runtime behavior changed, so no runtime tests were added and no tier-4 bench job was submitted. Runtime routing, payouts, rig controls and appliance fallback were not exercised by this prose correction. The repository's external link checker is scheduled, not a per-PR check; new local links and heading anchors were reviewed against the guides.