Skip to content

Deprecate old fees object in favor of expandedPriceImpact#339

Open
ted-palmer wants to merge 3 commits into
mainfrom
ted/int2-659-deprecate-old-fees-object-in-docs
Open

Deprecate old fees object in favor of expandedPriceImpact#339
ted-palmer wants to merge 3 commits into
mainfrom
ted/int2-659-deprecate-old-fees-object-in-docs

Conversation

@ted-palmer

Copy link
Copy Markdown
Collaborator

No description provided.

@github-actions

github-actions Bot commented Jun 15, 2026

Copy link
Copy Markdown

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


Code Review — Deprecate old fees object in favor of expandedPriceImpact

  • Gather context (diff, AGENTS.md style guide)
  • Review changes against style guide & correctness
  • Post review feedback

Overall this is a clean, well-executed deprecation. It follows the spirit of the §4.3 deprecation playbook (keep the surface documented, mark it superseded, point to the replacement with a <Warning>) adapted to an in-page object rather than a whole endpoint page. I verified the cross-references and they hold up. A couple of minor observations below.

✅ Verified correct

  • Anchor link [expandedPriceImpact](#fees-in-the-api) resolves — the new ## Fees in the API heading generates the slug fees-in-the-api.
  • Endpoint link [GET /requests/v2](/references/api/get-requests) is accurate — references/api/get-requests.mdx has openapi: get /requests/v2, and the path is root-relative per §2.6.
  • Callout length — the deprecation <Warning> is ~5 rendered lines with no nested code/tables, well under the 15-line cap (§2.5).
  • Reordering — moving the deprecated Fees Object content to the bottom under a clearly-labeled ## Deprecated: Fees Object section, after the current expandedPriceImpact docs, is the right call. Current guidance leads, deprecated trails.

🔸 Minor — separator inconsistency between the two fee lists

The current expandedPriceImpact list uses a hyphen lead-in (**execution** - …), while the deprecated fees list uses a colon (**relayerService**: …). Both bolded-lead patterns are acceptable under §2.4/§3.2, but having both styles on the same page reads slightly inconsistently. This pre-existed the PR (the old "Price Impact" vs "Fees Object" sections differed the same way), so it's optional — worth normalizing to one separator if you're touching it anyway.

🔸 Minor — script.js link label (fees.mdx page is not deprecated, the field is)

script.js:112 changes the API-playground annotation on the response-fees element to "Learn more about fees - [DEPRECATED]". Since response-fees annotates the fees field in the quote response, flagging that field as deprecated is reasonable. The only nit: the link still text-points to the whole fees concept page, which is not deprecated (it now documents expandedPriceImpact as the current path plus the deprecated object). A reader could read "[DEPRECATED]" as applying to the page. Consider wording that scopes the deprecation to the field, e.g. "fees (deprecated) — see expandedPriceImpact", so it doesn't imply the whole page is dead.

Notes

  • No docs.json nav change is needed (only an in-page object is deprecated, not a page), and §4.3 deprecations don't require a changelog entry — so nothing missing there.
  • Prose, terminology (basis-point, Relay fee), and the 2–3 sentence paragraph rule all look good.

Nothing here is blocking. ✅
ted/int2-659-deprecate-old-fees-object-in-docs

@github-actions

github-actions Bot commented Jun 15, 2026

Copy link
Copy Markdown

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


Code Review — Deprecate old fees object in favor of expandedPriceImpact

  • Gather context (diff, AGENTS.md style guide)
  • Review changes for correctness & style
  • Post review feedback

This is a clean deprecation that adapts the §4.3 playbook (keep the surface documented, mark it superseded with a <Warning>, point to the replacement) to an in-page object rather than a whole endpoint page. Leading with the current expandedPriceImpact docs and trailing the deprecated fees object under a clearly-labeled ## Deprecated: Fees Object is the right call. Nothing blocking.

✅ Verified correct

  • Anchor link[expandedPriceImpact](#fees-in-the-api) resolves: the renamed ## Fees in the API heading generates the slug fees-in-the-api.
  • Endpoint link[GET /requests/v2](/references/api/get-requests) is accurate; references/api/get-requests.mdx carries openapi: get /requests/v2, and the path is root-relative per §2.6.
  • No broken inbound anchors — the headings ## Fees Object and ## Price Impact were renamed/merged away, but I grepped the repo and nothing links to #fees-object or #price-impact, so no inbound links break.
  • Callout length — the deprecation <Warning> is ~5 rendered lines, no nested code/tables, well under the 15-line cap (§2.5).
  • Terminologybasis-point (hyphenated), Relay fee, and spelling out bpsbasis-point all align with §5; 2–3 sentence paragraph rule holds.

🔸 Minor — separator inconsistency between the two fee lists

The current expandedPriceImpact list uses a hyphen (**execution** - …) while the deprecated fees list uses a colon (**relayerService**: …). Both bolded-lead forms are acceptable (§2.4/§3.2), but having both on one page reads slightly inconsistently. This pre-existed the PR, so it's optional — worth normalizing to the hyphen form since you're already editing the section. Fix this →

🔸 Minor — script.js [DEPRECATED] label scopes to the page, not the field

script.js:112 relabels the playground annotation on response-fees to "Learn more about fees - [DEPRECATED]". response-fees annotates the fees field in the quote response, so flagging that field is reasonable — but the link still points to the whole fees concept page, which is not deprecated (it now documents expandedPriceImpact as the current path). A reader could read [DEPRECATED] as applying to the page. Consider scoping it to the field, e.g. "fees (deprecated) — use expandedPriceImpact". Fix this →

Notes

  • No docs.json nav change needed (an in-page object is deprecated, not a page), and §4.3 deprecations don't require a changelog entry — nothing missing there.

Both findings are non-blocking. ✅
ted/int2-659-deprecate-old-fees-object-in-docs

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