Skip to content

docs(deposit-addresses): clarify reindex section and link API ref to … - #316

Merged
ted-palmer merged 2 commits into
mainfrom
ted/int2-159-deposit-address-reindex-docs
May 15, 2026
Merged

ted-palmer merged 2 commits into
mainfrom
ted/int2-159-deposit-address-reindex-docs

Conversation

@ted-palmer

Copy link
Copy Markdown
Collaborator

…feature page

@ted-palmer
ted-palmer requested a review from pedromcunha May 14, 2026 18:36
@github-actions

github-actions Bot commented May 14, 2026 •

Copy link
Copy Markdown
Contributor

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


Code Review

  • Read CLAUDE.md style guide
  • Inspect diff vs. origin/main
  • Read both changed files in full
  • Cross-check style-guide compliance (feature guide §3.1, API reference §3.3)
  • Post review feedback

Small, well-scoped cleanup. Reads cleanly and follows the style guide. A few minor observations below — none blocking.

What works

  • Redundancy removal is the right call. The old page led with "the background monitor may not detect it" prose, then repeated the same point in a trailing <Info> callout. Folding it into the lead paragraph is correct per §2.5 (callouts are pointers, not duplicates).
  • API ref cross-link matches established precedent. [What are deposit addresses?](/features/deposit-addresses) mirrors the pattern already in references/api/get-app-fee-balances.mdx:7 and references/api/claim-app-fees.mdx:7 — bare link, no callout wrapper. Consistent with §3.3's "leave empty unless a cross-cutting note is needed."
  • Bolded lead-in for chainId semantics (features/deposit-addresses.mdx:1259) is a good fit for §2.9 (bold for emphasis on a parameter the reader has to recognize) and matches the bolded-lead pattern from §3.2.
  • Better example values. Swapping the placeholder chain IDs/currency for 42161 → 1 with the real USDC mainnet address (0xa0b86991c6218b36c1d19d4a2e9eb0ce3606eb48, correctly lowercased per §5) makes the wrong-chain recovery scenario concrete.

Minor suggestions (optional)

  1. features/deposit-addresses.mdx:1259 — trailing sentence is slightly redundant.

    "Pass targetChainId to run the reindex on a different chain — useful when funds were sent to the right address but on the wrong chain (e.g. the address was registered for Arbitrum but funds landed on Ethereum). This is the chain being reindexed, not the destination chain of the original quote."

    The third sentence restates what the second sentence already established (targetChainId is the chain being reindexed). The parenthetical example also already conveys the directionality. Consider dropping the final sentence — the paragraph would tighten from three sentences to two and still convey the same meaning. If the concern is readers conflating targetChainId with "destination chain of the quote," a shorter tail like "Not the quote's destination chain." would carry the same warning with less weight.

  2. Lost information: "Unknown currencies return 400." This was a small but practically useful note for integrators wiring up error handling. The OpenAPI spec covers response codes generically, but the semantic (unknown-on-this-chain → 400, not 404 or 422) was page-local context. Acceptable to drop, but if you want to keep it, a tail clause works: "…outside the standard solver-depositable list (e.g. a HyperCore-registered token when the deposit address was created for HyperEVM); unknown currencies return 400."

  3. Heading level is fine but worth flagging for the path-glob check. ### Reindexing Stuck Deposits sits under a ## parent in this page, which is the deepest allowed nesting per §2.2 — leave as-is, just calling out that any further sub-breakdown here would need to switch to bold lead-ins rather than ####.

Nits

  • The chainId clarification sentence uses **chainId is the chain…** (bold wrapping a code span). This is consistent with §2.9's prose-reference convention (**`paramName`**) — no change needed, just noting it for reviewers who flag the mixed emphasis.
  • e.g. / i.e. usage: both new e.g.'s use a comma-free form ("e.g. the address was registered…"). Repo is mixed on this — features/fast-fill.mdx uses both styles — so leaving as-is is fine.

Verdict

Ship it. The trailing-sentence redundancy in §2 is the only thing I'd consider before merge, and it's a polish call, not a correctness one.
• Branch

@mintlify

mintlify Bot commented May 14, 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 May 14, 2026, 6:41 PM

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

@github-actions

github-actions Bot commented May 14, 2026 •

Copy link
Copy Markdown
Contributor

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


Code Review

  • Read CLAUDE.md style guide
  • Inspect diff vs. origin/main
  • Read both changed files in full
  • Cross-check style-guide compliance (feature guide §3.1, API reference §3.3)
  • Post review feedback

Re-reviewing after the Merge branch 'main' sync (39c4832). The merge only pulled unrelated edits from features/deposit-addresses.mdx (the refund-table rows and the relay.link/withdraw <Info> from #314) — the Reindex section itself is unchanged since the last review. Verdict is the same: ship it.

Style-guide compliance (clean)

  • §2.5 callouts. Removing the trailing <Info> that restated the lead paragraph is the right call — callouts are pointers, not duplicates.
  • §2.6 links. [Deposit Address Reindex](/features/deposit-addresses) and [What are deposit addresses?](/features/deposit-addresses) both use root-relative paths.
  • §2.9 emphasis. **`chainId`** (bold + backticks) at features/deposit-addresses.mdx:1263 matches the prose-reference convention from features/fast-fill.mdx.
  • §2.10 paragraph length. Three new paragraphs at lines 1252/1263/1265 all clear the 2–3 sentence cap.
  • §3.3 API reference. The new line in references/api/deposit-address-reindex.mdx:7 mirrors get-app-fee-balances.mdx:7 and claim-app-fees.mdx:7 — bare link, no callout wrapper. Consistent.
  • §5 terminology. Chain names (Arbitrum, Ethereum) capitalized correctly; the new USDC address is correctly lowercased; chainId / targetChainId / currency referenced in backticks throughout.
  • Example values. 42161 → 1 with 0xa0b86991c6218b36c1d19d4a2e9eb0ce3606eb48 (USDC mainnet) lines up — a real, copy-pasteable scenario.

Optional polish (non-blocking, carried from prior review)

  1. features/deposit-addresses.mdx:1263 — trailing sentence is still slightly redundant. The bolded lead-in already pins down chainId; the parenthetical already conveys directionality. Dropping the final sentence (or shortening it to "Not the quote's destination chain.") would tighten the paragraph. Polish call only.
  2. "Unknown currencies return 400" was dropped. The semantic (unknown-on-this-chain → 400, not 404/422) was useful for integrators wiring error handling and isn't fully captured by the generic OpenAPI response codes. Fine to leave dropped, but if you want it back, a tail clause on line 1265 works: "…(e.g. a HyperCore-registered token when the deposit address was created for HyperEVM); unknown currencies return 400."
  3. "target chain" framing on line 1265. Reads as informal shorthand for "targetChainId if set, otherwise chainId." A reader who got here in order is fine, but a reader who jumps to this paragraph via search might wonder which chain. Minor — only worth tweaking if you're already in the file.

Nits

  • e.g. usage on lines 1263/1265 is comma-free ("e.g. the address was registered…"). Repo is mixed, so consistent with existing practice.
  • ### Reindexing Stuck Deposits sits at the §2.2 max depth (## parent). Any further sub-breakdown here would need bold lead-ins, not #### — flagging for future edits, no action needed now.

Verdict

Ship it. Polish items above are all optional; nothing is a correctness issue.
• Branch

@ted-palmer
ted-palmer merged commit 445f294 into main May 15, 2026
4 checks passed
@ted-palmer
ted-palmer deleted the ted/int2-159-deposit-address-reindex-docs branch May 15, 2026 18:58

This branch was successfully deployed

1 active deployment
staging — 39c48328 Deployed May 14, 2026 by mintlify[bot]
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.

2 participants