Skip to content

docs: update examples and scheme docs for facilitator integration - #4

Merged
A1igator merged 3 commits into
mainfrom
vraspar/update-facilitator-and-examples
Feb 7, 2026
Merged

docs: update examples and scheme docs for facilitator integration#4
A1igator merged 3 commits into
mainfrom
vraspar/update-facilitator-and-examples

Conversation

@vraspar

@vraspar vraspar commented Feb 5, 2026

Copy link
Copy Markdown
Contributor

Summary

  • Add facilitator app card to the examples page with endpoint details (/supported, /verify, /settle)
  • Update merchant-server card: now uses x402's standard paymentMiddleware + HTTPFacilitatorClient
  • Update running examples section with facilitator-first startup order and note
  • Add self-hosted facilitator section to the escrow scheme spec page
  • Update PaymentRequired JSON example: maxAmountRequired -> amount (x402 v2)
  • Add tip to merchant quickstart linking to facilitator-based middleware approach

Test plan

  • Preview with npx mint dev — verify all three updated pages render correctly
  • Verify internal links (/sdk/examples, /sdk/examples#merchant-server) work
  • Check code blocks render with syntax highlighting

🤖 Generated with Claude Code

- Add facilitator app card to examples page with /supported, /verify, /settle
- Update merchant-server description: now uses x402 standard paymentMiddleware
  with HTTPFacilitatorClient instead of custom middleware
- Update running examples section with facilitator-first startup order
- Add self-hosted facilitator section to escrow-scheme spec
- Update PaymentRequired JSON example: maxAmountRequired → amount (x402 v2)
- Add tip to merchant quickstart pointing to facilitator-based middleware

Co-Authored-By: Claude Opus 4.5 <noreply@anthropic.com>
@vraspar
vraspar requested a review from A1igator February 6, 2026 05:30
vraspar and others added 2 commits February 6, 2026 23:19
…n progress

- Fix facilitator location from apps/ to examples/ across examples and escrow-scheme pages
- Replace non-existent createFacilitatorSigner() with EscrowFacilitatorScheme
- Remove e2e-dispute card and section (no source code exists)
- Merge misleading "Apps" section into "Examples" section
- Fix merchant-server description (doesn't use X402rMerchant SDK)
- Mark arbiter-cli as "in progress" in examples and roadmap
- Fix test count from 316 to 310 in roadmap
- Add experimental/development warnings to SDK overview, installation, and index
- Change overview description from "Production-ready" to "experimental"

Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>
Remove ~1,590 lines of repetitive/generic content across 20 SDK doc
pages while preserving all method signatures and type definitions.

- Restructure nav: move examples to Getting Started, rename Helpers
  to Resource Server, slim Reference group
- Remove duplicate viem setup, Complete Examples, and boilerplate
  from all quickstart/subscription/reference pages
- Trim AI integration page (save full content to x402r-notes)
- Add GitHub href links to all example cards
- Fix broken Base Sepolia faucet links (base.org/faucet → docs.base.org)
- Remove redundant SDK experimental warning from index.mdx

Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>
@A1igator
A1igator merged commit 8e1f42c into main Feb 7, 2026
1 check passed
@A1igator
A1igator deleted the vraspar/update-facilitator-and-examples branch February 7, 2026 19:27
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>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants