Add deposit address marketing intro - #394
Conversation
|
Preview deployment for your docs. Learn more about Mintlify Previews.
💡 Tip: Enable Workflows to automatically generate PRs for you. |
|
Claude finished @pedromcunha's task in 2m 50s —— View job Code review: deposit address marketing intro
The positioning content itself is strong and the technical section below is untouched as claimed. My concerns are that a few of the new claims contradict the technical documentation further down the same page — in ways that could cause an integrator to lose funds — plus some structural duplication and style-guide drift. Blocking: new claims contradict the technical section1. This is stated as an unqualified user guarantee, but the technical section on this same page says the opposite in four places:
The contradiction is sharpest for the exact audience the intro leads with (L10: "a customer paying from a centralized exchange"), where L990 explicitly warns against relying on auto-refund to the depositor. An integrator who reads only the marketing intro can reasonably ship without Suggested: 2.
They can be sent — that's the whole hazard. L1413 carries a 3. L1393–1400 says deposit addresses add ~33,000 gas (native) to ~70,000 gas (ERC-20) of sweep overhead, and "For very small amounts, the gas overhead may make deposit addresses less cost-effective than direct calldata execution." A $5 checkout is the case the caveat is warning about. Either raise the figure or drop the specific dollar amount. 4. The technical flow (L69) says Relay "detects the deposit onchain and sweeps funds to the depository contract" before the fill, and L985 confirms the depository holds them. The claim isn't wrong in spirit, but the marketing wording invents a term ("non-custodial escrow") that appears nowhere else in these docs. Recommend matching the established vocabulary and linking to the Depository Contract — §5 asks for that link on first mention. 5. "Request an address via the API with your destination chain, output asset, and trade type" leaves out Structure6. Duplicated sections that will drift apart. The PR adds sections that overlap existing ones without consolidating:
Two 4-step flow lists and two Open-vs-Strict explanations, ~75 lines apart, both in the page TOC. The new mode summary at L18 is already thinner than the 7. §3.1's required definitional intro was removed. The profile states the one strictly required element is an intro paragraph using " 8. Marketing-first content on a
§2.6 asks for a link on first mention of a concept that has its own page. At minimum link out; ideally the audience positioning lives in Style-guide details
Verified as fine
No changes pushed — this is review feedback only. Findings 1 and 2 are the ones I'd want resolved before merge; the rest are judgment calls for you. |
Summary
Validation
git diff --checkNotes
Linear: https://linear.app/relayprotocol/issue/MAR-1395/deposit-addresses