Skip to content

docs(drift): draft from internal source - #353

Closed
pedromcunha wants to merge 1 commit into
mainfrom
docs-drift/src-e12ef1f6ac-ccd8b77
Closed

pedromcunha wants to merge 1 commit into
mainfrom
docs-drift/src-e12ef1f6ac-ccd8b77

Conversation

@pedromcunha

Copy link
Copy Markdown
Member

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

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 @matirelay via /publish-docs-pr
@mintlify

mintlify Bot commented Jul 2, 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 Jul 2, 2026, 2:23 PM

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

@pedromcunha
pedromcunha marked this pull request as ready for review July 3, 2026 02:23
@github-actions

github-actions Bot commented Jul 3, 2026 •

Copy link
Copy Markdown
Contributor

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


Code review — PR #353

  • Read the diff and surrounding context
  • Check against CLAUDE.md style rules
  • Verify content matches described behavior / no internal leakage
  • Post review feedback

This PR adds one changelog entry to references/api/changelog.mdx for the opt-in includeProtocolSignature flag. Overall it's clean and follows the §4.5 changelog format well. Details below.

✅ What's correct

  • §4.5 format — ## <YYYY-MM-DD> — <Short summary> heading, **Added** bolded lead, newest-first ordering (2026-07-02 sits above 2026-06-23). All good.
  • Field naming is consistent with existing docs — protocol.v2.orderId matches references/protocol/depository/guides/integrating.mdx, and depositErc20(depositor, token, amount, id) / the bytes32 id = orderId framing matches the EVM depository and for-apps guide. The "32-byte orderId" claim checks out (it's a bytes32).
  • Terminology (§5) — onchain (one word), lowercase solver, POST /quote / POST /quote/v2 endpoint style all match surrounding entries.
  • No internal leakage — no service names, file paths, or unreleased identifiers. "Failed to generate protocol order" is a user-facing error string, and "the signer" reads as observable behavior rather than an internal component name.

🟡 Suggestions (non-blocking)

  1. Missing cross-reference. Every other quote-related entry in this file links out to Handling Quote Errors (see the 2026-06-23 and 2026-06-05 entries). This entry mentions the "Failed to generate protocol order" failure and the onchain-verification concepts (orderId, depositErc20, ecrecover) with no See … link. Consider adding a trailing pointer for consistency, e.g. to orderId vs. requestId and/or Handling Quote Errors. Fix this →

  2. Paragraph length (§2.10 / §2.4). The **Added** body is a single 4-sentence paragraph. This technically exceeds the "2–3 sentences max" rule — but it's consistent with the existing long-paragraph entries in this file (e.g. 2026-06-23), so I'd treat the file-wide pattern as the intended style rather than fixing this one entry in isolation.

  3. Companion surfaces (§4.1) — for the human reviewer. A new optional request param + response field would normally also surface on the auto-generated get-quote / get-quote-v2 reference pages via the OpenAPI spec. No action needed in the MDX (those pages are spec-driven stubs per §3.3), but worth confirming the upstream OpenAPI spec was updated so the field actually renders there. Flagging per the "surfaces that might need a companion update" note in §4.1.

No correctness issues found; the entry accurately describes the behavior. Since this was a review request, I haven't made any changes.
• docs-drift/src-e12ef1f6ac-ccd8b77

@pedromcunha pedromcunha closed this Jul 7, 2026

This branch was successfully deployed

1 active deployment
staging — 8fc40732 Deployed Jul 2, 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