You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
This PR was auto-generated by the 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 docs-draft-pr.yml in relayprotocol/relay-kit.
The rename itself is clean and complete. Three things worth addressing before merge, one of which I'd consider blocking.
1. Missing changelog entry for a breaking option rename — AGENTS.md §4.2
duneConfig → codexConfig renames a public RelayKitProvider option. §4.2 requires breaking changes be logged in a per-product changelog, and explicitly names references/relay-kit/ui/changelog.mdx as the page to create "when the first breaking change in that surface ships." That page doesn't exist yet — this looks like the first UI-surface breaking change, so it should be created here.
This matters practically: an integrator who upgrades and keeps passing duneConfig gets no error. The option is silently ignored and token balances quietly vanish from the token selector — exactly the failure mode the changelog exists to catch. The pages-in-place edit is correct per §4.2, but the changelog is the only place that upgrade signal lives.
(Side note, pre-existing and out of scope: references/api/changelog.mdx exists on disk but isn't wired into docs.json — it currently renders only via direct URL.)
2. references/relay-kit/ui/relay-kit-provider.mdx:18 — bare docs link where the old one deep-linked
The sentence promises "how to get an API key," but https://docs.codex.io is the docs homepage. The Dune link it replaced pointed at …/authentication#generate-an-api-key. Worth deep-linking to Codex's equivalent page so the sentence delivers what it says.
3. relay-kit-provider.mdx:19 — please confirm the default https://graph.codex.io
This is a new factual claim that wasn't in the old text. Codex's GraphQL endpoint is commonly written as https://graph.codex.io/graphql, so it's worth checking whether the default in RelayKitProvider.tsx includes the /graphql path — anyone building the proxy this row describes will copy the value verbatim.
I could not verify this myself: fetching the source PR's file diffs required a permission this job doesn't have, so I only had the source PR's file list (which does confirm a demo/pages/api/codex/graphql.ts proxy was added, consistent with the GraphQL framing). Treat this as a check-against-source item, not a confirmed defect.
4. Style nits
:19 — "The base url" → "The base URL".
:19 — the apiBaseUrl cell is now three sentences. §2.7 says keep cell descriptions concise and move long explanations into prose below the table; the default-value sentence is the natural candidate to move. Fix this →
§2.7 wants Property cells bolded (**codexConfig.apiKey**). The entire Options table already skips this, so the changed rows are locally consistent — noting it only as optional cleanup, not a regression from this PR.
What checks out
No stale dune references anywhere in the repo. A case-insensitive grep across the whole tree returns zero matches, so nothing was left behind in troubleshooting.mdx, swap-widget.mdx, or elsewhere — the §4.2 "update inbound links" requirement is satisfied.
YOUR_CODEX_KEY matches the §2.8 all-caps placeholder convention, and both installation.mdx code blocks were updated consistently.
Capitalization improved — the old cell said "the dune api"; the new text uses "Codex API", matching §5.
Scope is right. The source PR also deletes useDuneBalances / useEclipseBalance and adds useCodexBalances / useSolanaBalance, but those are relay-kit-ui internal hooks. The Hooks reference documents only @relayprotocol/relay-kit-hooks exports, so no hooks page needed touching.
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Drafted from relayprotocol/relay-kit#1066, 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.