docs(review): address Greptile review feedback across the stack#96
Open
rodrigopavezi wants to merge 3 commits into
Open
docs(review): address Greptile review feedback across the stack#96rodrigopavezi wants to merge 3 commits into
rodrigopavezi wants to merge 3 commits into
Conversation
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.
This was referenced May 11, 2026
Merged
Merged
Merged
Merged
Merged
This was referenced May 11, 2026
Member
Author
Greptile SummaryThis PR applies 16 of 18 Greptile review comments from PRs #88–95, covering terminology updates (API Key → Client ID), component migrations (
Confidence Score: 5/5Safe to merge — all changes are documentation and tooling; no runtime logic is altered. Every change is confined to MDX documentation content, a JSON nav config, a dev script, and a package.json update. None of the edits touch production code paths. The two open observations (a stale {apiKey} annotation in a Mermaid diagram and mutually exclusive outcomes rendered as sequential Steps) are editorial issues that do not block a reader from using the API correctly. The Mermaid diagram in api-features/create-requests.mdx (auth annotation) and the Steps block in use-cases/compliance-gated-payments.mdx (branching outcomes) are worth a second editorial look, but neither blocks merging. Important Files Changed
Flowchart%%{init: {'theme': 'neutral'}}%%
flowchart TD
A[PR #96: Address Greptile Review Feedback] --> B[Auth Terminology]
A --> C[Component Migrations]
A --> D[Endpoint Fixes]
A --> E[Script & Config]
B --> B1["x-api-key → x-client-id\n(getting-started, integration-tutorial,\ncreate-requests, batch-payments, payouts)"]
B --> B2["RN_API_KEY → RN_CLIENT_ID\n(env var rename across docs)"]
C --> C1["Tabs → CodeGroup\n(programmatic-payment-links)"]
C --> C2["Numbered list → Steps\n(compliance-gated-payments)"]
C --> C3["Markdown table → Expandable + ParamField\n(payee-destinations)"]
D --> D1["/v2/ prefix added\n(crypto-to-fiat, query-payments)"]
D --> D2["paymentReference → requestId\n(create-requests)"]
D --> D3["timingSafeEqual buffer-length fix\n(programmatic-payment-links)"]
E --> E1["waitUntil: networkidle → load\n(capture-screenshots.ts)"]
E --> E2["Remove duplicate nav entry\n(docs.json)"]
E --> E3["Drop @playwright/test\n(package.json)"]
Reviews (3): Last reviewed commit: "docs(review): finish /v2/ prefix consist..." | Re-trigger Greptile |
![greptile-apps[bot]](https://avatars.githubusercontent.com/in/867647?s=60&v=4){kind=small}
Bundles two passes of Greptile feedback: (A) PR #96 follow-up — the fixes PR itself attracted two new comments: - use-cases/programmatic-payment-links.mdx: cURL language tag bash → curl - RN_API_KEY → RN_CLIENT_ID and X-Api-Key → x-client-id renamed across api-setup/integration-tutorial.mdx, api-setup/getting-started.mdx, api-features/create-requests.mdx for stack-wide consistency. Zero RN_API_KEY / X-Api-Key references remain. (B) Older PRs (51-87) — 23 still-applicable comments out of 51 total. The other 28 are stale (resolved by the revamp rewriting or removing the relevant sections/files); those will be resolved on GitHub with a note explaining staleness. PR #53 — getting-started.mdx - Added Express setup (express + app.use(express.json())) before the webhook handler example so the snippet is runnable. PR #54 — integration-tutorial.mdx - Added missing `import { eq } from 'drizzle-orm';`. - Fixed spelling "succesfully" → "successfully". PR #55 — create-requests.mdx - v2 pay endpoint takes requestId, not paymentReference (mermaid + code sample updated to `${requestId}/pay`). PR #56 + #87 — crosschain-payments.mdx - Boundary wording: "under \$1" → "of \$1 or less" to align with the "greater than 1 USD" half of the sentence. - viem snippet now imports createPublicClient + http and instantiates publicClient so `publicClient.waitForTransactionReceipt(...)` works. PR #57 — batch-payments.mdx - Code samples now use x-client-id (consistent with rest of docs), dropped legacy x-platform-id, added `if (!response.ok)` error handling on both examples. PR #59 — crypto-to-fiat-payments.mdx - "I**mportant:" → "**Important:" - mermaid: {payerId} → {clientUserId} (twice). - Endpoint paths: /payer → /v2/payer for consistency. - mermaid: declared "Payee Bank" as a participant (was used but never declared, breaking the diagram). PR #66 — query-payments.mdx - Frontmatter description: /payments → /v2/payments. PR #67 — platform-fees.mdx - Clarified query- vs body-param scope: GET /v2/request/{id}/pay uses query params; POST /v2/payouts and /payouts/batch use body params. PR #68 — protocol-fees.mdx - Grammar: "protocol fees applies" → "protocol fee applies". - Typo: "simple reduce" → "simply reduce". - Math: payee receives 999.50 USDC (not 999.95). Added intermediate invoice/fee lines for transparency. PR #77 — faq.mdx - On-ramp question now explicitly answered: "Fiat-to-crypto (on-ramp) payments are not currently supported by the API." PR #86 — payouts.mdx - "ERC-712" → "EIP-712" (correct EIP designation). PR #86 — api-reference/secure-payments.mdx - expiresAt example: 15 minutes → 7 days, matching the documented default expiry. PR #87 — payouts.mdx - Added "500" row to error-handling table. mintlify broken-links: zero.
Greptile follow-up on api-features/crypto-to-fiat-payments.mdx:127-129. The earlier fix added the /v2/ prefix to POST /v2/payer but missed the sibling GET and PATCH entries on the next lines — fixed now. All relative /payer/... references on the page use the versioned path.
MantisClone
reviewed
May 12, 2026
Member
MantisClone
left a comment
MantisClone
left a comment
There was a problem hiding this comment.
Reviewed the cumulative 40-PR stack against 6 source repos (request-api, request-auth-api, request-secure-payment, request-dashboard, request-token-list, request-infrastructure) plus the live preview at requestnetwork-docs-revamp-greptile-fixes.mintlify.app.
Two must-fix items below. Non-blocking observations will be filed as separate issues after deploy.
Must-fix #1 — SIWE example doesn't match server output
File: api-reference/wallet-authentication.mdx:35 (not in this PR's specific diff, so flagging here instead of inline)
The current message example shows a Chain ID: 1 line, omits an Expiration Time: line, and is missing the period after Sign in to Request Network. The actual server template at request-auth-api/src/auth/auth.service.ts:187-196 emits no Chain ID, always emits Expiration Time: (5 min after Issued At), and ends Sign in to Request Network. with a period.
Three edits:
- Drop the
Chain ID: 1line - Add
Expiration Time: <iso8601>(5 minutes afterIssued At) - Add the period:
Sign in to Request Network.
Corrected example:
auth.request.network wants you to sign in with your Ethereum account:
0x6923831ACf5c327260D7ac7C9DfF5b1c3cB3C7D7
Sign in to Request Network.
URI: https://auth.request.network
Version: 1
Nonce: a1b2c3d4e5f6
Issued At: 2026-03-15T10:00:00.000Z
Expiration Time: 2026-03-15T10:05:00.000Z
Why it matters: signature verification is byte-exact. Anyone typing the example verbatim to test will get Invalid challenge and have no way to figure out why.
Must-fix #2 — Client ID Generation flow doesn't match Dashboard UI
See inline comment on api-setup/getting-started.mdx.
Already handled
- bassgeta's CHANGES_REQUESTED on #54 has been dismissed
- Code Sandbox link drop on
api-setup/integration-tutorial.mdx:8is in Rodrigo's queue (theworkspaceIdquery parameter is user-scoped, so the link doesn't work for any non-author reader)
MantisClone
approved these changes
May 12, 2026
Member
Author
Merge activity
|
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.
Applies 16 of 18 Greptile review comments from PRs #88-95. Skipped:
exist)
PR #88
Client ID flow on the Dashboard.
PR #89
cross-chain note — Tron payments are same-chain; Li.Fi swap-to-pay
is EVM-source only.
Update blocks with topical sub-labels (Payouts, Tron, Accounting,
Calldata).
PR #90
Setup group. The Tools group in Resources is the canonical home.
to per AGENTS.md style. Other Tabs blocks (EVM-vs-Tron
variants) stay as Tabs since they are alternative content.
check to compare decoded buffer lengths instead of raw hex string
lengths.
PR #91
playwrightis used).to "load". Vite HMR keeps a persistent WebSocket open so networkidle
always timed out against dev servers.
PR #92
from <YOUR_API_KEY> to <YOUR_CLIENT_ID> for consistency.
PR #93
the self-contradiction ("redirected" vs "no auto-redirect").
example now captures the response and uses securePaymentUrl.
PR #94
Markdown table to with nested entries.
to with components.
PR #95
"you decide on the destination" (grammar).
description.
Payment Page are no-code hosted tools, not SDK consumers.