Skip to content

docs(drift): draft from internal source#311

Merged
pedromcunha merged 1 commit into
mainfrom
docs-drift/src-207dad012a-0e560fb
May 12, 2026
Merged

docs(drift): draft from internal source#311
pedromcunha merged 1 commit into
mainfrom
docs-drift/src-207dad012a-0e560fb

Conversation

@pedromcunha
Copy link
Copy Markdown
Member

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

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 @cucupac via /publish-docs-pr
@mintlify
Copy link
Copy Markdown
Contributor

mintlify Bot commented May 7, 2026

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

Project Status Preview Updated (UTC)
unevenlabs 🟢 Ready View Preview May 7, 2026, 8:32 PM

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

@pedromcunha pedromcunha marked this pull request as ready for review May 7, 2026 20:43
@pedromcunha pedromcunha requested a review from ted-palmer May 7, 2026 20:43
@github-actions
Copy link
Copy Markdown

github-actions Bot commented May 7, 2026

Claude finished @pedromcunha's task in 1m 37s —— View job


Code Review

  • Read changed files and diff against origin/main
  • Check style guide conformance (CLAUDE.md)
  • Verify content accuracy and cross-references
  • Post review feedback

This is a small, well-targeted update that documents a behavior flip for strict deposit-address overpayments. Content is consistent across the comparison table (features/deposit-addresses.mdx:65), the prose subsection (features/deposit-addresses.mdx:893-896), and the changelog (references/api/changelog.mdx:6-8). One style-guide deviation worth fixing before merge.

🟡 Style — changelog lead-in label not in CLAUDE.md §4.5

references/api/changelog.mdx:8 uses Behavior change as the bolded lead, but §4.5 of CLAUDE.md codifies exactly three lead-in labels: Breaking, Deprecated, Added. Per §4.4, an observable behavior change goes into the changelog "per §4.2" — and §4.2 is the breaking-change playbook. This diff does change observable behavior for any integrator that was relying on strict-overpayment fills scaling up to the deposited amount, so the conventional label is Breaking.

Two reasonable options:

  1. Relabel to **Breaking** to match the spec.
  2. Update the spec in the same PR to introduce a fourth **Behavior change** lead-in, with a one-liner in §4.5 explaining when to use it vs. **Breaking**.

Recommend option 1 — it's the smaller change and matches the existing 2026-04-28 entry's framing.

Fix this →

🟢 Content / consistency check — passes

  • Comparison table cell, the ### Strict Addresses bullet list, and the changelog entry all describe the same three cases (underpay → refund, exact → fill, overpay → fill quoted + refund excess). No drift between the three surfaces.
  • The refundTo requirement is consistently restated where relevant (table row, changelog, existing <Warning>).
  • Backtick / bold usage on refundTo, amount, useDepositAddress, strict matches §2.9.
  • New prose respects the 2–3 sentence paragraph cap (§2.10) and uses active, product-as-subject voice (§2.3).
  • No internal-only names (service names, file paths, unreleased identifiers) leaked.

🔵 Minor — pre-existing, optional

references/api/changelog.mdx ends without a trailing newline (visible as \ No newline at end of file in the diff). This is pre-existing from the previous commit, not introduced here, but worth fixing opportunistically.


Summary

LGTM once the changelog lead-in is relabeled from Behavior changeBreaking (or §4.5 is extended to allow it). Everything else looks good — content is internally consistent and follows the §3.1 feature-guide profile.
· Branch: docs-drift/src-207dad012a-0e560fb

@pedromcunha pedromcunha merged commit 4bb6cd8 into main May 12, 2026
5 checks passed
@pedromcunha pedromcunha deleted the docs-drift/src-207dad012a-0e560fb branch May 12, 2026 20:46
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.

3 participants