Skip to content

docs(feedback): apply Tristan's revisions from RequestNetwork/request-api#806#95

Merged
rodrigopavezi merged 1 commit into
mainfrom
docs/revamp-tristan-feedback
May 12, 2026
Merged

docs(feedback): apply Tristan's revisions from RequestNetwork/request-api#806#95
rodrigopavezi merged 1 commit into
mainfrom
docs/revamp-tristan-feedback

Conversation

@rodrigopavezi
Copy link
Copy Markdown
Member

7 amendments across 3 pages:

  1. Welcome page subtitle rewritten:
    "Request Network protocol allows you to be paid and pay at scale
    without intermediaries across EVM and Tron. Our protocol offers the
    instant payment reconciliation, click-to-pay payment links, and
    cross-chain routing that Web3 payments need."

  2. Welcome page section renamed "Three on-ramps" -> "Three Products"
    with new subtitle pointing at Dashboard, Secure Payment Page, and
    API. Renamed the Secure Payment card to "Secure Payment Page" for
    consistency.

  3. Multi-Chain Checkout: "you fix the destination" -> "you decide of
    the destination" in the Why multi-chain matters section.

  4. Batch Payouts What you'll build: "gas-amortized" -> "gas-sponsored".

  5. Reordered the two batch modes - Hosted Batch Link is now Mode 1
    (Recommended & Safer Approach), Direct Execution is Mode 2
    (Advanced & Self-Secure). Added Tristan's rationale for each.

  6. Cross-chain capability differences spelled out per mode:

    • Hosted Batch Link supports cross-chain execution from a single
      wallet connection with automatic routing across EVM chains.
    • Direct Execution is same-chain only; cross-chain requires one
      transaction per chain on each network's deployed contracts.
  7. Added a wallet-infrastructure compatibility note: Secure Payment
    Page and Dashboard not compatible with Safe multisigs today;
    recommend Utila, DFNS, or Fireblocks for corporate treasury;
    WalletConnect-based infrastructure is fully compatible.

This was referenced May 11, 2026
@rodrigopavezi rodrigopavezi marked this pull request as ready for review May 11, 2026 13:59
Copy link
Copy Markdown
Member Author

rodrigopavezi commented May 11, 2026

This stack of pull requests is managed by Graphite. Learn more about stacking.

@greptile-apps
Copy link
Copy Markdown

greptile-apps Bot commented May 11, 2026

Greptile Summary

This PR applies editorial revisions across three documentation pages — the Welcome page, Multi-chain Checkout, and Batch Payouts — reflecting feedback from RequestNetwork/request-api#806. The most structural change is in batch-payouts.mdx, where the two payout modes are reordered so Hosted Batch Link becomes the recommended Mode 1 and Direct Execution is demoted to the advanced Mode 2, with new cross-chain capability descriptions and a wallet-infrastructure compatibility note added.

  • Welcome page: Subtitle rewritten, section renamed from "Three on-ramps" to "Three Products", and the Secure Payment card renamed to "Secure Payment Page".
  • Multi-chain Checkout: "you fix the destination" → "you decide of the destination" (grammar issue being corrected in docs(review): address Greptile review feedback across the stack #96).
  • Batch Payouts: Modes reordered and annotated with new cross-chain and safety rationale; gas-amortized changed to gas-sponsored; wallet-infrastructure compatibility note added.

Confidence Score: 3/5

The batch-payouts page now contains directly contradictory statements about cross-chain support — Mode 1 says it works, the Limits section says it doesn't — which needs resolution before merging.

Mode 1 explicitly introduces cross-chain execution capability for Hosted Batch Link, but the Limits section was not updated and still asserts "Same network only — all requests[] must target the same chain." A developer reading the Limits section will conclude cross-chain batching is impossible, directly contradicting the Mode 1 description on the same page.

use-cases/batch-payouts.mdx — specifically the Limits section, which needs to be qualified to clarify that the same-chain constraint applies only to Direct Execution (Mode 2), not to the Hosted Batch Link (Mode 1).

Important Files Changed

Filename Overview
use-cases/batch-payouts.mdx Modes reordered (Hosted Batch Link is now Mode 1, Direct Execution Mode 2) and cross-chain/wallet-compatibility notes added; introduces a contradiction between Mode 1's cross-chain capability and the unchanged Limits section that still says "Same network only" for all requests[].
use-cases/multi-chain-checkout.mdx Single phrase change: "you fix the destination" → "you decide of the destination"; grammatical issue ("decide of") already flagged and being corrected in #96.
use-cases/welcome.mdx Welcome page subtitle and section title/subtitle updated; the "SDK" framing for no-code products is a previously flagged issue being addressed in #96.

Flowchart

%%{init: {'theme': 'neutral'}}%%
flowchart TD
    A[Batch Payout Request] --> B{Choose Mode}
    B --> C["Mode 1 — Hosted Batch Link\nPOST /v2/secure-payments\n✅ Recommended & Safer"]
    B --> D["Mode 2 — Direct Execution\nPOST /v2/payouts/batch\n⚠️ Advanced & Self-Secure"]
    C --> E["Returns pay.request.network URL\nPayer reviews & signs once"]
    E --> F["Cross-chain routing via Li.Fi\nSingle wallet connection\nMultiple EVM chains"]
    D --> G["Returns calldata\nBackend broadcasts tx"]
    G --> H["Same-chain only\nOne tx per chain required"]
    F --> I[Settlement + Webhooks]
    H --> I
Loading

Comments Outside Diff (1)

  1. use-cases/batch-payouts.mdx, line 199-204 (link)

    P1 Limits section contradicts Mode 1's cross-chain capability

    The ## Limits section states "Same network only — all requests[] must target the same chain. No mixing Base + Arbitrum in one batch." But Mode 1 introduced by this PR explicitly says the Hosted Batch Link "supports cross-chain execution from a single wallet connection" and that "The Secure Payment Page handles routing and cross-chain execution automatically." These two statements directly conflict. A reader of the Limits section will conclude cross-chain batching is impossible, which contradicts the Mode 1 description above it. The Limits section needs a qualifier specifying that the same-chain constraint applies only to Mode 2 (Direct Execution / POST /v2/payouts/batch).

Reviews (2): Last reviewed commit: "docs(feedback): apply Tristan's revision..." | Re-trigger Greptile

Comment thread use-cases/multi-chain-checkout.mdx
Comment thread use-cases/batch-payouts.mdx
Comment thread use-cases/welcome.mdx
Copy link
Copy Markdown
Member Author

rodrigopavezi commented May 12, 2026

Merge activity

  • May 12, 4:02 PM UTC: A user started a stack merge that includes this pull request via Graphite.
  • May 12, 5:20 PM UTC: Graphite rebased this pull request as part of a merge.
  • May 12, 5:21 PM UTC: @rodrigopavezi merged this pull request with Graphite.

@rodrigopavezi rodrigopavezi changed the base branch from docs/revamp-kyt to graphite-base/95 May 12, 2026 17:17
@rodrigopavezi rodrigopavezi changed the base branch from graphite-base/95 to main May 12, 2026 17:18
…-api#806

7 amendments across 3 pages:

1. Welcome page subtitle rewritten:
   "Request Network protocol allows you to be paid and pay at scale
   without intermediaries across EVM and Tron. Our protocol offers the
   instant payment reconciliation, click-to-pay payment links, and
   cross-chain routing that Web3 payments need."

2. Welcome page section renamed "Three on-ramps" -> "Three Products"
   with new subtitle pointing at Dashboard, Secure Payment Page, and
   API. Renamed the Secure Payment card to "Secure Payment Page" for
   consistency.

3. Multi-Chain Checkout: "you fix the destination" -> "you decide of
   the destination" in the Why multi-chain matters section.

4. Batch Payouts What you'll build: "gas-amortized" -> "gas-sponsored".

5. Reordered the two batch modes - Hosted Batch Link is now Mode 1
   (Recommended & Safer Approach), Direct Execution is Mode 2
   (Advanced & Self-Secure). Added Tristan's rationale for each.

6. Cross-chain capability differences spelled out per mode:
   - Hosted Batch Link supports cross-chain execution from a single
     wallet connection with automatic routing across EVM chains.
   - Direct Execution is same-chain only; cross-chain requires one
     transaction per chain on each network's deployed contracts.

7. Added a wallet-infrastructure compatibility note: Secure Payment
   Page and Dashboard not compatible with Safe multisigs today;
   recommend Utila, DFNS, or Fireblocks for corporate treasury;
   WalletConnect-based infrastructure is fully compatible.
@rodrigopavezi rodrigopavezi force-pushed the docs/revamp-tristan-feedback branch from 05c00a4 to 6705aa7 Compare May 12, 2026 17:19
@rodrigopavezi rodrigopavezi merged commit e643dee into main May 12, 2026
2 checks passed
@rodrigopavezi rodrigopavezi deleted the docs/revamp-tristan-feedback branch May 12, 2026 17:21
rodrigopavezi added a commit that referenced this pull request May 12, 2026
Applies 16 of 18 Greptile review comments from PRs #88-95. Skipped:
- PR #88 forward-links comment (resolved by Phase B in #90 — pages now
  exist)
- PR #91 lockfile exclusion (P2 opinion; team has chosen to gitignore)

PR #88
- getting-started.mdx: replaced the "API Key Generation" steps with the
  Client ID flow on the Dashboard.

PR #89
- secure-payment-supported-networks-and-currencies.mdx: qualified the
  cross-chain note — Tron payments are same-chain; Li.Fi swap-to-pay
  is EVM-source only.
- release-notes/request-api.mdx: distinguished the four "2026-Q1"
  Update blocks with topical sub-labels (Payouts, Tron, Accounting,
  Calldata).

PR #90
- docs.json: removed the duplicate tools/dashboard entry from the API
  Setup group. The Tools group in Resources is the canonical home.
- programmatic-payment-links.mdx: TS/Python/cURL switched from <Tabs>
  to <CodeGroup> per AGENTS.md style. Other Tabs blocks (EVM-vs-Tron
  variants) stay as Tabs since they are alternative content.
- programmatic-payment-links.mdx: fixed the timingSafeEqual signature
  check to compare decoded buffer lengths instead of raw hex string
  lengths.

PR #91
- package.json: dropped @playwright/test (only `playwright` is used).
- scripts/capture-screenshots.ts: switched waitUntil from "networkidle"
  to "load". Vite HMR keeps a persistent WebSocket open so networkidle
  always timed out against dev servers.

PR #92
- integration-tutorial.mdx: changed the webhook-section .env placeholder
  from <YOUR_API_KEY> to <YOUR_CLIENT_ID> for consistency.

PR #93
- secure-payments.mdx: rewrote the redirectUrl description to remove
  the self-contradiction ("redirected" vs "no auto-redirect").
- programmatic-payment-links.mdx: the "send back to your site" code
  example now captures the response and uses securePaymentUrl.

PR #94
- payee-destinations.mdx: accessPolicy sub-fields restructured from a
  Markdown table to <Expandable> with nested <ParamField> entries.
- compliance-gated-payments.mdx: "How it works" numbered list switched
  to <Steps> with <Step> components.

PR #95
- multi-chain-checkout.mdx: "you decide of the destination" →
  "you decide on the destination" (grammar).
- batch-payouts.mdx: removed the duplicate "hosted" in the Mode 1
  description.
- welcome.mdx: dropped the SDK framing — the Dashboard and Secure
  Payment Page are no-code hosted tools, not SDK consumers.
rodrigopavezi added a commit that referenced this pull request May 12, 2026
Applies 16 of 18 Greptile review comments from PRs #88-95. Skipped:
- PR #88 forward-links comment (resolved by Phase B in #90 — pages now
  exist)
- PR #91 lockfile exclusion (P2 opinion; team has chosen to gitignore)

PR #88
- getting-started.mdx: replaced the "API Key Generation" steps with the
  Client ID flow on the Dashboard.

PR #89
- secure-payment-supported-networks-and-currencies.mdx: qualified the
  cross-chain note — Tron payments are same-chain; Li.Fi swap-to-pay
  is EVM-source only.
- release-notes/request-api.mdx: distinguished the four "2026-Q1"
  Update blocks with topical sub-labels (Payouts, Tron, Accounting,
  Calldata).

PR #90
- docs.json: removed the duplicate tools/dashboard entry from the API
  Setup group. The Tools group in Resources is the canonical home.
- programmatic-payment-links.mdx: TS/Python/cURL switched from <Tabs>
  to <CodeGroup> per AGENTS.md style. Other Tabs blocks (EVM-vs-Tron
  variants) stay as Tabs since they are alternative content.
- programmatic-payment-links.mdx: fixed the timingSafeEqual signature
  check to compare decoded buffer lengths instead of raw hex string
  lengths.

PR #91
- package.json: dropped @playwright/test (only `playwright` is used).
- scripts/capture-screenshots.ts: switched waitUntil from "networkidle"
  to "load". Vite HMR keeps a persistent WebSocket open so networkidle
  always timed out against dev servers.

PR #92
- integration-tutorial.mdx: changed the webhook-section .env placeholder
  from <YOUR_API_KEY> to <YOUR_CLIENT_ID> for consistency.

PR #93
- secure-payments.mdx: rewrote the redirectUrl description to remove
  the self-contradiction ("redirected" vs "no auto-redirect").
- programmatic-payment-links.mdx: the "send back to your site" code
  example now captures the response and uses securePaymentUrl.

PR #94
- payee-destinations.mdx: accessPolicy sub-fields restructured from a
  Markdown table to <Expandable> with nested <ParamField> entries.
- compliance-gated-payments.mdx: "How it works" numbered list switched
  to <Steps> with <Step> components.

PR #95
- multi-chain-checkout.mdx: "you decide of the destination" →
  "you decide on the destination" (grammar).
- batch-payouts.mdx: removed the duplicate "hosted" in the Mode 1
  description.
- welcome.mdx: dropped the SDK framing — the Dashboard and Secure
  Payment Page are no-code hosted tools, not SDK consumers.
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.

1 participant