docs: rewrite for voice consistency and factual accuracy#334
Merged
Conversation
Co-Authored-By: Claude Opus 4.8 <noreply@anthropic.com>
Co-Authored-By: Claude Opus 4.8 <noreply@anthropic.com>
Co-Authored-By: Claude Opus 4.8 <noreply@anthropic.com>
Co-Authored-By: Claude Opus 4.8 <noreply@anthropic.com>
Co-Authored-By: Claude Opus 4.8 <noreply@anthropic.com>
Co-Authored-By: Claude Opus 4.8 <noreply@anthropic.com>
Co-Authored-By: Claude Opus 4.8 <noreply@anthropic.com>
Co-Authored-By: Claude Opus 4.8 <noreply@anthropic.com>
Co-Authored-By: Claude Opus 4.8 <noreply@anthropic.com>
Co-Authored-By: Claude Opus 4.8 <noreply@anthropic.com>
Co-Authored-By: Claude Opus 4.8 <noreply@anthropic.com>
Co-Authored-By: Claude Opus 4.8 <noreply@anthropic.com>
Co-Authored-By: Claude Opus 4.8 <noreply@anthropic.com>
Co-Authored-By: Claude Opus 4.8 <noreply@anthropic.com>
Co-Authored-By: Claude Opus 4.8 <noreply@anthropic.com>
Co-Authored-By: Claude Opus 4.8 <noreply@anthropic.com>
Co-Authored-By: Claude Opus 4.8 <noreply@anthropic.com>
Co-Authored-By: Claude Opus 4.8 <noreply@anthropic.com>
Co-Authored-By: Claude Opus 4.8 <noreply@anthropic.com>
Co-Authored-By: Claude Opus 4.8 <noreply@anthropic.com>
Co-Authored-By: Claude Opus 4.8 <noreply@anthropic.com>
…erstatement Checked the [TODO] figures against two live 31 GB-RAM boxes (pithead-prod pruned, gouda full): - Disk confirmed: Monero ~102 GB pruned / ~266 GB full, Tari ~139 GB. Bumped the Tari figure 135 -> 140 GB (measured 138-139, growing) and resolved the TODO. - Fixed an overstatement: Tari (~140 GB) does NOT rival a *full* Monero node (~265 GB) — it's the largest consumer only once Monero is pruned (vs ~100 GB). - Fixed the same mdb_copy error corrected in test-server-architecture.md: reclaim space on an existing full chain with monero-blockchain-prune, not mdb_copy -c. - Clarified the per-service RAM figures are provisioning minimums; steady-state RSS is far lower (monerod/p2pool a few hundred MB; Tari 2-4 GB and climbing). Co-Authored-By: Claude Opus 4.8 <noreply@anthropic.com>
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
A voice + accuracy pass over every prose doc, matching the cadence of the p2pool / xmrig / monero READMEs: one factual opening line, imperative procedures, plain
NOTE:warnings, concrete numbers/ports/flags, link out instead of inlining, zero marketing.Primarily voice. Technical facts, commands, flags, addresses, and ports are unchanged except where a doc was factually wrong versus the code — those are corrected and listed below. Every command, flag, default, and port was verified against the actual source (
pithead,docker-compose.yml,config.reference.json,config.py, Dockerfiles,Makefile, test scripts). One commit per file for independent review.Not touched (already in voice, or out of scope):
docs/benchmarks/tor-vs-clearnet.md,tests/integration/README.md,tests/integration/testbench-README.md(no changes needed);CHANGELOG.md+docs/test-inventory.md+ generated/vendor/template files (excluded by design).1. Files changed (21)
README.mddocs/README.mddocs/getting-started.mddocs/configuration.mddocs/workers.mddocs/architecture.mddocs/privacy.mddocs/operations.mdpitheadsubcommand re-verified against the script.docs/dashboard.mdSyncing...badge text (below).docs/hardware.mdmdb_copyerror.docs/testing-strategy.mddocs/testing-guide.mddocs/integration-testing.mdrun.shflags verified.docs/releasing.mdVERSION, image names, Tari pin, stale claim (below).docs/release-server.mddocs/test-server-architecture.mddocs/faq.mdCONTRIBUTING.mdmain→develop(below).SECURITY.mdbuild/dashboard/README.mdsim/; fixed thenode --testinvocation (below).images/launch/README.md2. Accuracy corrections
docs/privacy.mdcommand:"pitheadinjects--socks5 <prefix>.25:9050 --socks5-proxy-type tor. Knob isp2pool.clearnet(defaultfalse). No compose editing.pithead:1149,config.py:132docs/dashboard.md:15Syncing…(Unicode ellipsis)Syncing...(three ASCII dots)web/views.py:682docs/testing-strategy.md:22grep 'def test_'docs/testing-guide.md:38tests/service/test_data_service.pybuild/dashboard/tests/service/test_data_service.pydocs/releasing.mdVERSIONis0.1.0"VERSIONis1.0.3VERSION:1docs/releasing.md${STACK_VERSION}into compose"docker-compose.yml:20,51,…docs/releasing.mddashboard, p2pool, …pithead-*docker-compose.yml:20,51,…docs/releasing.mdminotari_node:vX-mainnetv5.3.1-mainnetby digestdocker-compose.yml:107docs/test-server-architecture.mdmdb_copy -cmonero-blockchain-prune --copy-pruned-database(mdb_copyfailsMDB_VERSION_MISMATCHon Monero's patched LMDB)tests/integration/compact-chain.sh:15-16,49CONTRIBUTING.md:32,69maindevelop(mainis released-only).github/workflows/ci.yml:5,Makefile:12build/dashboard/README.md:30-33tests/frontend/components.test.mjsrenders every card throughAppagainst a realbuild_state()fixturebuild/dashboard/tests/frontend/build/dashboard/README.md:48sim/mining_dashboard/sim/donation_model.pyexistsbuild/dashboard/README.md:68node --test tests/frontend/*.test.mjsnode --test tests/frontend/docs/hardware.mdpithead-prod139 GB,gouda138 GB / 266 GBdocs/hardware.mdmdb_copy -cmdb_copy; usemonero-blockchain-prunetests/integration/compact-chain.sh:15-16docs/hardware.md~135 GB~140 GBpithead-prod/gouda3. Open items
docs/hardware.md— the sizing figures were verified against two live 31 GB-RAM deployments (pithead-prodpruned,goudafull): Monero ~102 GB pruned / ~266 GB full and Tari ~139 GB confirm the documented disk sizes; the per-service RAM figures are provisioning minimums (real RSS is far lower). The[TODO]is resolved and removed.Do not merge — for review.