Skip to content

rename Relay Fee to Platform Fee, adopt cost terminology - #382

Open
ted-palmer wants to merge 1 commit into
mainfrom
ted/update-fee-language
Open

rename Relay Fee to Platform Fee, adopt cost terminology#382
ted-palmer wants to merge 1 commit into
mainfrom
ted/update-fee-language

Conversation

@ted-palmer

Copy link
Copy Markdown
Collaborator

No description provided.

@ted-palmer
ted-palmer requested review from n-xlkt and pedromcunha July 30, 2026 15:46
@github-actions

github-actions Bot commented Jul 30, 2026

Copy link
Copy Markdown

Claude finished @ted-palmer's task in 1m 54s —— View job


Code review — PR #382

  • Read the diff and full fees.mdx
  • Check repo-wide for stale "Relay Fee" / old terminology references
  • Check consistency with AGENTS.md style guide (§2, §3.3a, §4.2, §5)
  • Post review

The rename direction is right and matches the API: relayplatform already shipped as the v3 field name (see references/api/api_guides/migrating-to-requests-v3.mdx:330), so aligning prose to Platform Fee removes a real mismatch. The cost-vs-fee split for execution/swap also reads well. A few things to tighten before merge.


1. The rename stops at this file — five other in-scope pages still say "Relay fee"

AGENTS.md §4.2 requires inbound references to the old name be updated in the same PR. Left stale:

File Line Text
references/api/api_core_concepts/trade-types.mdx 13, 18, 25 "relay fees, app fees, and gas fees" (×3)
features/fee-sponsorship.mdx 52 "sponsor specific Relay fees … (such as gas fees or relayer fees)"
features/fee-sponsorship.mdx 212 "designed to cover relay and execution costs"
solutions/payment-service-providers.mdx 62 "its execution, swap, and Relay fee components … revenue share on the Relay fee"

Also worth a pass: the link text [Relay Fees](/references/api/api_core_concepts/fees) appears in features/fee-sponsorship.mdx:239,260, features/price-stabilization.mdx:1303, references/api/api_guides/calling-integration-guide.mdx:1033, and references/api/api_guides/bridging-integration-guide.mdx:172. The target page is titled "Fee Structure", and "Relay Fees" now collides with the component name this PR is retiring — "Fee Structure" is the clearer label.

Fix this →

2. Capitalization of the new cost terms is inconsistent within the file

The numbered list and the <Tip> treat them as proper nouns — Execution Cost (fees.mdx:8, :15), Swap Cost (:17), :132–133 — but the API section lowercases them: "Execution costs" (:120), "Swap costs" (:122). Since :124 capitalizes "Platform Fee" in that same block, the three components should agree. AGENTS.md §5 treats named things as capitalized and generic prose usage as lowercase, so pick one reading and apply it to all three.

3. 4. **App Fees** is now the odd one out

fees.mdx:108 stays plural while items 1–3 became singular, and the <Tip> at :135 maps appApp Fee (singular). Either make the heading "App Fee" or keep all four plural.

4. Inline "earlier versions" trace vs. §4.2 — and no changelog entry

fees.mdx:28 adds "Referred to as the Relay Fee in earlier versions of the API and docs." AGENTS.md §4.2 says to edit in place and not leave an old-version trace in-line — the record belongs in references/api/changelog.mdx (which exists, entries through 2026-07-28), with the inline exception being a one-line <Info> pointing at the changelog entry.

Judgment call: the API field itself isn't changing in this PR (it became platform back in the v3 migration), so this is a docs-terminology change and a changelog entry is arguably optional. But the searchability argument for keeping the alias sentence is real. My suggestion: keep it, and add a short changelog entry so the sentence has something to point to — or drop it, since fees.mdx:141 already documents that v2 names the component relay.

5. Confirm the <Tip> guidance change is intentional

This is more than a rename. The old mapping collapsed swap + execution into one user-facing "Swap Impact" line and labeled platform as "Provider Fee"; the new one surfaces four separate lines. Integrators who built UI against the old advice will need a layout change, not a string change. If that's the intent, fine — just flagging that it isn't a no-op for consumers.

6. Nit — fees.mdx:6

"…there are four potential fee and cost components." The original trailing colon introduced the numbered list; a period reads as a full stop right before a list. Suggest: "…there are four potential cost and fee components:".


Not checked: no lint/build step was run — this repo has no test suite wired for MDX in the checkout, and Mintlify rendering (particularly the raw <table> blocks at :30 and :60, unchanged by this PR) can only be verified in a preview deploy.
• branch ted/update-fee-language

@mintlify

mintlify Bot commented Jul 30, 2026

Copy link
Copy Markdown
Contributor

Preview deployment for your docs. Learn more about Mintlify Previews.

Project Status Preview Updated (UTC)
unevenlabs 🟢 Ready View Preview Jul 30, 2026, 3:47 PM

💡 Tip: Enable Workflows to automatically generate PRs for you.

@mintlify

mintlify Bot commented Jul 30, 2026

Copy link
Copy Markdown
Contributor

Preview deployment for your docs. Learn more about Mintlify Previews.

Project Status Preview Updated (UTC)
unevenlabs 🟡 Building Jul 30, 2026, 3:46 PM

💡 Tip: Enable Workflows to automatically generate PRs for you.

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