docs: fix naming, addresses, code examples across 8 pages - #2
Merged
Conversation
…0 pages Reviewed contracts and x402-integration docs against source of truth (x402r-contracts repo and x402r-sdk config). Key fixes: - Standardize on PaymentOperator (not ArbitrationOperator) everywhere - Fix EscrowPeriodCondition → EscrowPeriod naming - Rewrite ethers.js testing section to use viem - Add missing uint256 amount param to ICondition.check() examples - Convert pseudo-code new ClassName() to factory deployment patterns - Fill in TBD factory/singleton addresses from SDK config - Fix state diagram transitions (reclaim/refundPostEscrow from Released) - Fix event names to match actual contract ABI - Add inline architecture diagram to architecture.mdx - Fix broken /quickstart links → /sdk/client/quickstart (all 3 pages) - Fix Example 3 freeze caller to match RECEIVER_CONDITION config - Fix Example 7 subscription diagram contradicting no-refund config - Rename Introduction → "What is x402r?" for clearer nav - Add icon to index.mdx landing page Co-Authored-By: Claude Opus 4.5 <noreply@anthropic.com>
vraspar
force-pushed
the
vraspar/fix-docs-review-issues
branch
from
February 5, 2026 04:29
dcda87b to
2f52556
Compare
A1igator
approved these changes
Feb 5, 2026
A1igator
added a commit
that referenced
this pull request
May 12, 2026
Two remaining review items that apply post-orphan-trim: #6 (docs.json SDK group renames + create-client promotion): - Promote sdk/create-client to second entry under "Getting Started" (was buried under "Reference"). Reference group now just CLI + Examples. - sidebarTitle frontmatter added so nav labels disambiguate: - sdk/merchant/getting-started → "Express server setup" - sdk/merchant/quickstart → "Merchant client" - sdk/helpers/forward-to-arbiter → "forwardToArbiter helper" #4 (typed Returns/Parameters per method, viem-style): - sdk/merchant/quickstart.mdx: added Parameters + Returns sections under each of capture, voidPayment, charge, refund, getAmounts, getState, operator.getConfig, operator.getFeeAddresses, operator.calculateFees. Tables list every arg with type and description; Returns names the typed result + key fields. - sdk/merchant/refund-handling.mdx: same pass across refund.has, refund.getStatus, refund.get, refund.getByKey, refund.getReceiverRequests, refund.getOperatorRequests, refund.deny, payment.voidPayment, freeze.isFrozen, freeze.unfreeze. Existing bottom-of-page summary table kept as quick reference. Skipped #2 (split deploy-operator.mdx into marketplace + delivery sibling pages): adding files contradicts the orphan-trim direction we just landed. Verified: npx mintlify@latest broken-links passes. Co-Authored-By: Claude Opus 4.7 (1M context) <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
2 participants
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.
Summary
PaymentOperator(not ArbitrationOperator),EscrowPeriod(not EscrowPeriodCondition)ICondition.check()signatures to include all 3 parameters (paymentInfo,amount,caller)new ClassName()patterns to factory deployment patterns/quickstartlinks to point to/sdk/client/quickstartFiles Changed (8)
contracts/examples.mdxcontracts/conditions.mdxcontracts/overview.mdxcontracts/core-contracts.mdxcontracts/architecture.mdxcontracts/factories.mdxx402-integration/comparison.mdxx402-integration/escrow-scheme.mdxTest plan
npx mintlify devand verify all 8 pages render/sdk/client/quickstart,/contracts/*)🤖 Generated with Claude Code