Skip to content

docs(drift): draft from internal source#323

Merged
ipeleg merged 1 commit into
mainfrom
docs-drift/src-3d453eaf11-13f24fc
May 27, 2026
Merged

docs(drift): draft from internal source#323
ipeleg merged 1 commit into
mainfrom
docs-drift/src-3d453eaf11-13f24fc

Conversation

@pedromcunha
Copy link
Copy Markdown
Member

Drafted from an internal source repo, requested by @ipeleg.

This PR was auto-generated by the reusable-docs-draft-pr workflow from a Claude-drafted update in the source repo. It is opened as a draft — please review, edit as needed, and mark ready for review before merging.

Review checklist

  • Content matches the behavior shipped in the source PR
  • No internal-only details (service names, file paths, unreleased names, security internals) leaked into the draft
  • Conforms to CLAUDE.md style rules
  • Cross-references and internal links resolve
  • Any Needs human input items from the source comment are addressed

Generated by reusable-docs-draft-pr.yml in relayprotocol/agents-config.

Requested by @ipeleg via /publish-docs-pr
@ipeleg ipeleg marked this pull request as ready for review May 27, 2026 16:13
@github-actions
Copy link
Copy Markdown

github-actions Bot commented May 27, 2026

Claude finished @ipeleg's task in 1m 7s —— View job


Review: PR #323depositTxHash docs drift

  • Read changed files in full context
  • Check conformance to CLAUDE.md style rules
  • Check for leaked internal-only details
  • Verify cross-references / internal links resolve
  • Post review feedback

This is a clean, well-scoped drift PR. It adds the new depositTxHash field in three consistent places: the GET /requests/v2 example (features/deposit-addresses.mdx:963), the webhook example payload (references/api/api_guides/webhooks.mdx:54), and a new changelog entry (references/api/changelog.mdx:6-8). I have no blocking concerns.

What's good

  • Changelog entry follows §4.5 — newest-first ordering, ## YYYY-MM-DD — summary heading, **Added** lead. The body usefully disambiguates depositTxHash (depositor → deposit address) from inTxHashes (deposit address → depository), which is exactly the kind of non-obvious context the changelog should carry.
  • No internal-only details leaked — depositTxHash is a public API field; no service names, paths, or unreleased names.
  • Both internal links referenced in the surrounding context resolve (get-requests.mdx, get-intents-status-v3.mdx exist). The webhook inline comment style (//nullable — …) matches the neighboring depositor line.

Minor suggestions (non-blocking)

  1. Link the endpoint in the changelog. Other entries link endpoints on mention (e.g. the 2026-05-26 entry links GET /intents/status/v3). For consistency with §2.6, consider linking GET /requests/v2/references/api/get-requests in the new entry. Fix this →

  2. Trailing comma in the json block. features/deposit-addresses.mdx:963 ends the new field with a trailing comma before }, which is invalid strict JSON in a block fenced as ```json. This is pre-existing (the depositor line carried the same trailing comma before this PR, so it's not a regression), and the webhooks block is effectively JSONC (// comments), so neither is paste-and-run JSON. Worth a cleanup pass if you want the json-fenced example to be strictly valid, but not required by this PR.

Otherwise conforms to CLAUDE.md. Looks ready to mark for review.

@mintlify
Copy link
Copy Markdown
Contributor

mintlify Bot commented May 27, 2026

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

Project Status Preview Updated (UTC)
unevenlabs 🟢 Ready View Preview May 27, 2026, 4:30 PM

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

@ipeleg ipeleg merged commit 57ff38e into main May 27, 2026
5 checks passed
@ipeleg ipeleg deleted the docs-drift/src-3d453eaf11-13f24fc branch May 27, 2026 18:35
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