Skip to content

Requests v3 migration guide#360

Open
ted-palmer wants to merge 9 commits into
mainfrom
ted/int2-636-request-v2-v3-migration-guide
Open

Requests v3 migration guide#360
ted-palmer wants to merge 9 commits into
mainfrom
ted/int2-636-request-v2-v3-migration-guide

Conversation

@ted-palmer

Copy link
Copy Markdown
Collaborator

No description provided.

@ted-palmer
ted-palmer requested review from ipeleg and pedromcunha July 8, 2026 20:20
@github-actions

This comment was marked as outdated.

@github-actions

This comment was marked as outdated.

@github-actions

This comment was marked as outdated.

@github-actions

github-actions Bot commented Jul 9, 2026

Copy link
Copy Markdown

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


Review: Requests v3 migration guide (re-review)

  • Gather PR diff & current branch state
  • Verify prior feedback items were addressed
  • Review all changed files against style guide (AGENTS.md)
  • Post review feedback

Re-reviewed the latest branch state. The guide is in great shape — definitional intro, clean ##/### hierarchy, expandable on the large JSON blocks (§2.8), the three-tab v2 / v3 / Difference layout as a justified use of tabs (§2.8), and the <AccordionGroup> "What changed" / "Field migration reference" sections read clearly. Nav wiring in docs.json is clean and correct.

Here's where the prior feedback landed:

✅ Resolved — v2/v3 reference links now render the correct specs

This was the main open issue and it's cleanly fixed:

  • references/api/get-requests.mdxopenapi: get /requests/v3 (v3 links resolve to v3).
  • New references/api/get-requests-v2.mdxopenapi: get /requests/v2 with a <Warning> pointing to v3 and the migration guide (§4.3 pattern, verbatim).
  • Wired into the Deprecated nav group in docs.json:164.
  • Both GET /requests/v2 links in fees.mdx (lines 138, 154) now point to /references/api/get-requests-v2, so they render v2. 👍

✅ Resolved — non-breaking hyphens (U+2011)

All 17 occurrences of (U+2011) are gone — grep now returns zero matches. same-chain, catch-all, JSON-encoded, etc. all use ASCII - and match §5.

🟡 Still open — intro paragraph exceeds the 2–3 sentence cap (§2.10)

migrating-to-requests-v3.mdx:6 is still four sentences ("…latest version…" / "It gives you…" / "This guide covers…" / "v2 stays available…"). Minor — split or trim the last two.

Fix this →

Nits (non-blocking)

  • Anchor #what-changed (migrating-to-requests-v3.mdx:456): the "Added" table links "Filtering, search & sorting" to #what-changed. Accordion titles don't generate their own anchors, so it lands at the section top rather than the specific accordion — won't deep-link, but acceptable.
  • Prose parameter emphasis (§2.9): params like `data.fees` / `x-api-key` use backticks only; the guide prefers bold+backticks (**`data.fees`**). Repo practice is mixed, so low priority.
  • The Difference tab intentionally repeats keys (failReason, fees, appFees, inTxs…) to pair [!code --]/[!code ++] lines — invalid as strict JSON but fine as illustrative jsonc. No change needed.
  • style.css just adds a trailing newline — harmless.

Net: both blocking items from the prior rounds are resolved. Only the cosmetic intro-length item and a few nits remain — none blocking. LGTM.
ted/int2-636-request-v2-v3-migration-guide

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