docs: clarify MRWK transfer and bridge status#396
Conversation
|
No actionable comments were generated in the recent review. 🎉 ℹ️ Recent review info⚙️ Run configurationConfiguration used: Repository UI Review profile: ASSERTIVE Plan: Pro Plus Run ID: 📒 Files selected for processing (3)
📝 WalkthroughWalkthroughThis PR updates documentation across README.md, docs/ledger.md, and docs/agent-guide.md to clarify that MRWK is currently a native ledger coin with three supported transfer paths (work payouts, contributor balance claiming, and signed wallet-to-wallet transfers), explicitly stating that public bridges, exchange/off-ramps, BTC, USDC, and fiat operations are not currently supported. ChangesMRWK Transfer Capabilities Documentation
Estimated code review effort🎯 1 (Trivial) | ⏱️ ~3 minutes Possibly related issues
🚥 Pre-merge checks | ✅ 4 | ❌ 1❌ Failed checks (1 inconclusive)
✅ Passed checks (4 passed)
✏️ Tip: You can configure your own custom pre-merge checks in the settings. ✨ Finishing Touches🧪 Generate unit tests (beta)
Comment |
Karry2019web
left a comment
There was a problem hiding this comment.
No blockers from my review on current head.
Evidence checked:
- Inspected
README.md,docs/agent-guide.md,docs/ledger.mddiff — covers the full Bounty #395 scope: current MRWK transfer paths (GitHub balance claims, linked mrwk1 wallets, signed wallet-to-wallet transfers), explicitly separates from future bridge/onchain-claim experiments, and includes the required "separate maintainer/contributor discussion before implementation" framing. - The prose is short, direct, and human. No investment, price, bridge-claim, cash-out, or fabricated payout language.
- The contributor added
#current-transfer-pathsanchor indocs/ledger.mdand linked it fromREADME.md— matches the acceptance criteria.
One minor observation (not a blocker): the scripts/docs_smoke.py change wasn't shown in the diff — confirming docs smoke coverage was not needed for these changes per the bounty description's "Add or update docs smoke coverage only if needed" clause.
ayskobtw-lil
left a comment
There was a problem hiding this comment.
No blockers from my review on current head e5e72c0.
Evidence checked:
- Inspected the changed
README.md,docs/ledger.md, anddocs/agent-guide.mdtext against Bounty #395. - Verified the docs enumerate only the current native MRWK transfer paths: accepted payouts to linked
mrwk1wallets or temporarygithub:{login}accounts, GitHub balance claims into linked wallets, and signed wallet-to-wallet transfers between registeredmrwk1wallets. - Verified the future bridge/onchain language is framed as non-live design work and does not imply a current BTC, USDC, fiat, public bridge, exchange, liquidity, price, cash-out, or off-ramp path.
- Checked the new README pointer resolves to
docs/ledger.md#current-transfer-paths.
Validation run locally:
python scripts/docs_smoke.py-> docs smoke okpython -m ruff check README.md docs/ledger.md docs/agent-guide.md scripts/docs_smoke.py-> All checks passedgit diff --check origin/main...HEAD-> cleangit merge-tree --write-tree origin/main HEAD-> merge tree written successfully, no conflicts
Summary
docs/ledger.mdcurrent transfer paths for GitHub balance claims, linkedmrwk1wallets, and registered wallet-to-wallet transfers.Validation
./.venv/bin/python scripts/docs_smoke.py-> docs smoke ok./.venv/bin/python -m ruff check scripts/docs_smoke.py-> passedgit diff --check-> passed./.venv/bin/python -m ruff format --check README.md docs/ledger.md docs/agent-guide.md-> not applicable; Ruff reports Markdown formatting is experimental and requires preview modeBounty #395
No private keys, seed material, secrets, deployment credentials, private vulnerability details, payout credentials, price claims, or off-ramp promises are included.
Summary by CodeRabbit