docs(drift): draft from relayprotocol/relay-kit#983#304
Conversation
Requested by @pedromcunha via /publish-docs-pr on relayprotocol/relay-kit#983
|
Preview deployment for your docs. Learn more about Mintlify Previews.
💡 Tip: Enable Workflows to automatically generate PRs for you. |
|
Claude finished @pedromcunha's task in 2m 8s —— View job Code ReviewReviewed both files against 🔴 Content bug — contradictory intro
The first sentence promises withdrawal support; the second sentence takes it back. This is more confusing than the original Suggest either reverting to the prior "deposit only + Relay supports depositing to Lighter from any supported chain (withdrawal support is coming soon). To try it today, use the [Relay App](https://relay.link/bridge/lighter). This document details how to integrate Lighter deposits into your application.🟠 Likely typo — package namespace
Every other Relay package on this page (and across the docs) uses the 🟠 Code example likely breaks at runtime
const walletClient = createWalletClient({
chain: mainnet,
transport: custom(window.ethereum!)
})
const account = walletClient.account!When const walletClient = createWalletClient({
chain: mainnet,
transport: custom(window.ethereum!)
})
const [address] = await walletClient.requestAddresses()
const adaptedWallet = adaptLighterWallet({
l1Address: address,
signL1Message: (message) =>
walletClient.signMessage({ account: address, message })
})(The pre-existing 🟡 Style nits
🔵 Pre-existing drift worth cleaning upNot introduced by this PR, but visible while the file is open:
Checklist
|
|
Claude finished @pedromcunha's task in 2m 48s —— View job Code ReviewRe-reviewed after the two follow-up commits. The withdrawal flow ( 🔴 Previously flagged — still unresolved1. Runtime bug in Lighter code example const walletClient = createWalletClient({
chain: mainnet,
transport: custom(window.ethereum!)
})
const account = walletClient.account!
const walletClient = createWalletClient({
chain: mainnet,
transport: custom(window.ethereum!)
})
const [address] = await walletClient.requestAddresses()
const adaptedWallet = adaptLighterWallet({
l1Address: address,
signL1Message: (message) =>
walletClient.signMessage({ account: address, message })
})2. Likely typo — package namespace Still inconsistent with 3. Missing language tag on code fences Both fences are bare 4. H1 in body — pre-existing drift still in place Per §2.2, the frontmatter 🟠 New issues introduced by this revision5. Frontmatter description is now stale description: "How to deposit to Lighter from any Relay chain"The page now documents both deposits and withdrawals ( description: "How to deposit to and withdraw from Lighter using the Relay API"6. Intro paragraph stale in the same way The intro ends with "This document details how to integrate Lighter deposits into your application." — but the doc now also walks through withdrawals. Broaden to "…how to integrate Lighter deposits and withdrawals into your application." 7. Internal links use absolute URLs Per §2.6, internal links must be root-relative: 🟡 Style nits
✅ Resolved from prior review
Checklist
|
|
Claude finished @pedromcunha's task in 1m 42s —— View job Code ReviewRe-reviewed after commit 🔴 New bug — undefined reference in Lighter code example
const [address] = await walletClient.requestAddresses()
const adaptedWallet = adaptLighterWallet({
l1Address: address,
signL1Message: (message) =>
walletClient.signMessage({ account, message })
})The fix renamed the variable from signL1Message: (message) =>
walletClient.signMessage({ account: address, message })🔴 Still unresolved — package namespace typo
Still inconsistent with 🔴 Still unresolved — internal links use absolute URLs
Per §2.6, internal links must be root-relative. Should be 🟠 Still unresolved — H1 in body
Per §2.2, the frontmatter 🟡 Style nits
✅ Resolved from prior review
Checklist
|
|
Claude finished @pedromcunha's task in 2m 50s —— View job Code ReviewRe-reviewed after commit 🔴 Still unresolved — package namespace typo (flagged 3× now)
Still inconsistent with 🔴 Still unresolved — absolute internal link
Per §2.6, internal links must be root-relative. Line 14 was fixed in this revision; line 444 was missed. Should be 🔵 New regression in this PR —
|
|
Claude encountered an error —— View job Code ReviewRe-reviewed after commit 🔴 Still unresolved — package namespace typo (flagged 4× now)
Every other Relay package across this repo uses the
Either way, 🟠 Pre-existing drift worth cleaning up (not introduced by this PR)
🟡 Style nits (unchanged from prior review — low-priority)
✅ Resolved in this revision
Checklist
· Branch · |
|
Claude finished @pedromcunha's task in 1m 35s —— View job Code ReviewRe-reviewed after commit 🔴 Still unresolved — package namespace typo (flagged 5× now)
Every other Relay package across this repo uses the
🟠 Still outstanding — H1 in body (pre-existing, not introduced by this PR)
Good news — this is already 🟡 Style nits (unchanged — low-priority, judgment calls)
✅ Resolved from prior reviews (carried forward, still good)
Checklist
Summary: The only remaining blocker is the · · Branch |
pedromcunha
deleted the
docs-drift/relayprotocol-relay-kit-pr-983-d3d6fe2
branch
2 participants
Drafted from relayprotocol/relay-kit#983, requested by @pedromcunha.
This PR was auto-generated by the
docs-draft-prworkflow 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
CLAUDE.mdstyle rulesNeeds human inputitems from the source comment are addressedGenerated by
docs-draft-pr.ymlinrelayprotocol/relay-kit.