-
Notifications
You must be signed in to change notification settings - Fork 563
Update portal label to TypeScript SDK #7658
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Update portal label to TypeScript SDK #7658
Conversation
WalkthroughThis update removes the "Engine" API link from the header navigation and changes multiple references of the SDK name from "Connect SDK" to either "TypeScript SDK" or "thirdweb SDK" across various documentation, UI components, metadata, and sidebar files. No logic or control flow is modified. Changes
Estimated code review effort1 (~5 minutes) Warning Review ran into problems🔥 ProblemsErrors were encountered while retrieving linked issues. Errors (1)
📜 Recent review detailsConfiguration used: CodeRabbit UI 📒 Files selected for processing (19)
💤 Files with no reviewable changes (1)
✅ Files skipped from review due to trivial changes (11)
🚧 Files skipped from review as they are similar to previous changes (7)
⏰ Context from checks skipped due to timeout of 90000ms. You can increase the timeout in your CodeRabbit configuration to a maximum of 15 minutes (900000ms). (8)
✨ Finishing Touches
🪧 TipsChatThere are 3 ways to chat with CodeRabbit:
SupportNeed help? Create a ticket on our support page for assistance with any issues or questions. Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments. CodeRabbit Commands (Invoked using PR comments)
Other keywords and placeholders
CodeRabbit Configuration File (
|
The latest updates on your projects. Learn more about Vercel for Git ↗︎
|
How to use the Graphite Merge QueueAdd either label to this PR to merge it via the merge queue:
You must have a Graphite account in order to use the merge queue. Sign up using this link. An organization admin has enabled the Graphite Merge Queue in this repository. Please do not merge from GitHub as this will restart CI on PRs being processed by the merge queue. |
|
Codecov ReportAll modified and coverable lines are covered by tests ✅
Additional details and impacted files@@ Coverage Diff @@
## main #7658 +/- ##
=======================================
Coverage 56.40% 56.40%
=======================================
Files 908 908
Lines 58228 58228
Branches 4226 4226
=======================================
Hits 32844 32844
Misses 25274 25274
Partials 110 110
🚀 New features to boost your workflow:
|
size-limit report 📦
|
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Actionable comments posted: 0
🧹 Nitpick comments (1)
apps/portal/src/app/references/typescript/[version]/layout.tsx (1)
17-17
: Trim trailing space in the<title>
string
A super-fluous space at the end of the string may leak into the rendered<title>
tag or fail strict string comparisons in tests.- title: "References | thirdweb TypeScript SDK ", + title: "References | thirdweb TypeScript SDK",
📜 Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro
📒 Files selected for processing (2)
apps/portal/src/app/Header.tsx
(0 hunks)apps/portal/src/app/references/typescript/[version]/layout.tsx
(1 hunks)
💤 Files with no reviewable changes (1)
- apps/portal/src/app/Header.tsx
🧰 Additional context used
📓 Path-based instructions (2)
**/*.{ts,tsx}
📄 CodeRabbit Inference Engine (CLAUDE.md)
**/*.{ts,tsx}
: Write idiomatic TypeScript with explicit function declarations and return types
Limit each file to one stateless, single-responsibility function for clarity
Re-use shared types from@/types
or localtypes.ts
barrels
Prefer type aliases over interface except for nominal shapes
Avoidany
andunknown
unless unavoidable; narrow generics when possible
Choose composition over inheritance; leverage utility types (Partial
,Pick
, etc.)
Comment only ambiguous logic; avoid restating TypeScript in prose
Files:
apps/portal/src/app/references/typescript/[version]/layout.tsx
**/*.{ts,tsx,js,jsx}
📄 CodeRabbit Inference Engine (CLAUDE.md)
Load heavy dependencies inside async paths to keep initial bundle lean (lazy loading)
Files:
apps/portal/src/app/references/typescript/[version]/layout.tsx
🧠 Learnings (2)
📓 Common learnings
Learnt from: CR
PR: thirdweb-dev/js#0
File: CLAUDE.md:0-0
Timestamp: 2025-07-18T19:19:55.613Z
Learning: Surface breaking changes prominently in PR descriptions
Learnt from: CR
PR: thirdweb-dev/js#0
File: CLAUDE.md:0-0
Timestamp: 2025-07-18T19:19:55.613Z
Learning: Applies to apps/{dashboard,playground-web}/**/*.{ts,tsx} : Server Components (Node edge): Start files with `import "server-only";`
apps/portal/src/app/references/typescript/[version]/layout.tsx (10)
Learnt from: CR
PR: thirdweb-dev/js#0
File: CLAUDE.md:0-0
Timestamp: 2025-07-18T19:19:55.613Z
Learning: Applies to src/exports/react.native.ts : React Native specific exports are in src/exports/react.native.ts
Learnt from: CR
PR: thirdweb-dev/js#0
File: CLAUDE.md:0-0
Timestamp: 2025-07-18T19:19:55.613Z
Learning: Applies to apps/{dashboard,playground-web}/**/*.{tsx} : Expose className
prop on root element of components for overrides
Learnt from: CR
PR: thirdweb-dev/js#0
File: CLAUDE.md:0-0
Timestamp: 2025-07-18T19:19:55.613Z
Learning: Applies to apps/{dashboard,playground-web}/**/*.{ts,tsx} : Server Components (Node edge): Start files with import "server-only";
Learnt from: CR
PR: thirdweb-dev/js#0
File: .cursor/rules/dashboard.mdc:0-0
Timestamp: 2025-07-18T19:20:32.530Z
Learning: Applies to dashboard/**/layout.tsx : Building layout shells (layout.tsx
) and top-level pages that mainly assemble data.
Learnt from: CR
PR: thirdweb-dev/js#0
File: CLAUDE.md:0-0
Timestamp: 2025-07-18T19:19:55.613Z
Learning: Applies to apps/{dashboard,playground-web}/**/*.{ts,tsx} : Use design system tokens (e.g., bg-card
, border-border
, text-muted-foreground
)
Learnt from: CR
PR: thirdweb-dev/js#0
File: CLAUDE.md:0-0
Timestamp: 2025-07-18T19:19:55.613Z
Learning: Applies to apps/{dashboard,playground-web}/**/*.{ts,tsx} : Client Components (browser): Begin files with 'use client';
Learnt from: CR
PR: thirdweb-dev/js#0
File: .cursor/rules/dashboard.mdc:0-0
Timestamp: 2025-07-18T19:20:32.530Z
Learning: Applies to dashboard/**/*.{ts,tsx} : Export default async functions without 'use client';
– they run on the Node edge.
Learnt from: CR
PR: thirdweb-dev/js#0
File: CLAUDE.md:0-0
Timestamp: 2025-07-18T19:19:55.613Z
Learning: Applies to apps/{dashboard,playground-web}/**/*.{ts,tsx} : Import UI primitives from @/components/ui/*
(Button, Input, Select, Tabs, Card, Sidebar, Badge, Separator) in dashboard and playground apps
Learnt from: CR
PR: thirdweb-dev/js#0
File: CLAUDE.md:0-0
Timestamp: 2025-07-18T19:19:55.613Z
Learning: Applies to **/*.{ts,tsx} : Write idiomatic TypeScript with explicit function declarations and return types
Learnt from: CR
PR: thirdweb-dev/js#0
File: CLAUDE.md:0-0
Timestamp: 2025-07-18T19:19:55.613Z
Learning: Applies to **/*.{ts,tsx} : Comment only ambiguous logic; avoid restating TypeScript in prose
🔇 Additional comments (1)
apps/portal/src/app/references/typescript/[version]/layout.tsx (1)
8-8
: ✅ SDK title change aligns with new branding
The update from “Connect SDK” → “TypeScript SDK” is correct and consistent with the rest of the metadata below.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Actionable comments posted: 1
🧹 Nitpick comments (1)
apps/portal/src/app/typescript/v5/connecting-wallets/page.mdx (1)
15-16
: Optional wording tweak for clarityInsert the article “the” before the SDK name for smoother reading.
- "Learn how to connect various types of wallets using TypeScript SDK", + "Learn how to connect various types of wallets using the TypeScript SDK",
📜 Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro
📒 Files selected for processing (17)
apps/dashboard/src/@/components/contracts/code-overview.tsx
(1 hunks)apps/dashboard/src/app/(app)/(dashboard)/tools/transaction-simulator/components/TransactionSimulator.tsx
(1 hunks)apps/dashboard/src/app/(app)/team/[team_slug]/(team)/~/support/_components/contact-forms/connect/index.tsx
(1 hunks)apps/dashboard/src/app/(app)/team/components/Analytics/EmptyState.tsx
(1 hunks)apps/portal/src/app/contracts/explore/pre-built-contracts/account-factory/page.mdx
(1 hunks)apps/portal/src/app/contracts/explore/pre-built-contracts/managed-account-factory/page.mdx
(1 hunks)apps/portal/src/app/engine/v2/features/relayers/page.mdx
(1 hunks)apps/portal/src/app/infrastructure/sidebar.tsx
(1 hunks)apps/portal/src/app/pay/guides/cross-chain-swapping/page.mdx
(1 hunks)apps/portal/src/app/react/v5/connecting-wallets/ui-components/page.mdx
(1 hunks)apps/portal/src/app/react/v5/in-app-wallet/how-to/interact-blockchain/page.mdx
(1 hunks)apps/portal/src/app/react/v5/rainbow-kit-migrate/page.mdx
(1 hunks)apps/portal/src/app/typescript/v5/connecting-wallets/page.mdx
(2 hunks)apps/portal/src/app/typescript/v5/wallets/page.mdx
(1 hunks)apps/portal/src/app/wallets/external-wallets/com.coinbase.wallet/page.tsx
(1 hunks)apps/portal/src/app/wallets/quickstart/page.mdx
(1 hunks)packages/react-native-adapter/README.md
(3 hunks)
✅ Files skipped from review due to trivial changes (16)
- apps/dashboard/src/@/components/contracts/code-overview.tsx
- apps/portal/src/app/react/v5/rainbow-kit-migrate/page.mdx
- apps/portal/src/app/engine/v2/features/relayers/page.mdx
- apps/portal/src/app/infrastructure/sidebar.tsx
- apps/dashboard/src/app/(app)/team/components/Analytics/EmptyState.tsx
- apps/portal/src/app/wallets/quickstart/page.mdx
- apps/portal/src/app/pay/guides/cross-chain-swapping/page.mdx
- apps/portal/src/app/react/v5/connecting-wallets/ui-components/page.mdx
- apps/portal/src/app/contracts/explore/pre-built-contracts/account-factory/page.mdx
- apps/portal/src/app/typescript/v5/wallets/page.mdx
- apps/portal/src/app/contracts/explore/pre-built-contracts/managed-account-factory/page.mdx
- apps/dashboard/src/app/(app)/(dashboard)/tools/transaction-simulator/components/TransactionSimulator.tsx
- apps/portal/src/app/wallets/external-wallets/com.coinbase.wallet/page.tsx
- apps/portal/src/app/react/v5/in-app-wallet/how-to/interact-blockchain/page.mdx
- packages/react-native-adapter/README.md
- apps/dashboard/src/app/(app)/team/[team_slug]/(team)/~/support/_components/contact-forms/connect/index.tsx
🧰 Additional context used
🧠 Learnings (2)
📓 Common learnings
Learnt from: CR
PR: thirdweb-dev/js#0
File: CLAUDE.md:0-0
Timestamp: 2025-07-18T19:19:55.613Z
Learning: Surface breaking changes prominently in PR descriptions
Learnt from: CR
PR: thirdweb-dev/js#0
File: .cursor/rules/dashboard.mdc:0-0
Timestamp: 2025-07-18T19:20:32.530Z
Learning: Applies to dashboard/**/*client.tsx : Anything that consumes hooks from `@tanstack/react-query` or thirdweb SDKs.
Learnt from: MananTank
PR: thirdweb-dev/js#7227
File: apps/dashboard/src/app/(app)/(dashboard)/(chain)/[chain_id]/[contractAddress]/modules/components/OpenEditionMetadata.tsx:26-26
Timestamp: 2025-05-30T17:14:25.332Z
Learning: The ModuleCardUIProps interface already includes a client prop of type ThirdwebClient, so when components use `Omit<ModuleCardUIProps, "children" | "updateButton">`, they inherit the client prop without needing to add it explicitly.
Learnt from: MananTank
PR: thirdweb-dev/js#7356
File: apps/nebula/src/app/not-found.tsx:1-1
Timestamp: 2025-06-17T18:30:52.976Z
Learning: In the thirdweb/js project, the React namespace is available for type annotations (like React.FC) without needing to explicitly import React. This is project-specific configuration that differs from typical TypeScript/React setups.
Learnt from: CR
PR: thirdweb-dev/js#0
File: CLAUDE.md:0-0
Timestamp: 2025-07-18T19:19:55.613Z
Learning: Applies to apps/{dashboard,playground-web}/**/*.{ts,tsx} : Server Components (Node edge): Start files with `import "server-only";`
apps/portal/src/app/typescript/v5/connecting-wallets/page.mdx (11)
Learnt from: CR
PR: thirdweb-dev/js#0
File: .cursor/rules/dashboard.mdc:0-0
Timestamp: 2025-07-18T19:20:32.530Z
Learning: Applies to dashboard/**/*client.tsx : Interactive UI that relies on hooks (useState
, useEffect
, React Query, wallet hooks).
Learnt from: CR
PR: thirdweb-dev/js#0
File: CLAUDE.md:0-0
Timestamp: 2025-07-18T19:19:55.613Z
Learning: Applies to test/src/test-wallets.ts : Predefined test accounts are in test/src/test-wallets.ts
Learnt from: CR
PR: thirdweb-dev/js#0
File: CLAUDE.md:0-0
Timestamp: 2025-07-18T19:19:55.613Z
Learning: Applies to packages/thirdweb/src/wallets/** : EIP-1193, EIP-5792, EIP-7702 standard support in wallet modules
Learnt from: CR
PR: thirdweb-dev/js#0
File: CLAUDE.md:0-0
Timestamp: 2025-07-18T19:19:55.613Z
Learning: Applies to apps/{dashboard,playground-web}/**/*.{ts,tsx} : Use design system tokens (e.g., bg-card
, border-border
, text-muted-foreground
)
Learnt from: CR
PR: thirdweb-dev/js#0
File: CLAUDE.md:0-0
Timestamp: 2025-07-18T19:19:55.613Z
Learning: Surface breaking changes prominently in PR descriptions
Learnt from: CR
PR: thirdweb-dev/js#0
File: CLAUDE.md:0-0
Timestamp: 2025-07-18T19:19:55.613Z
Learning: Applies to src/exports/react.native.ts : React Native specific exports are in src/exports/react.native.ts
Learnt from: CR
PR: thirdweb-dev/js#0
File: CLAUDE.md:0-0
Timestamp: 2025-07-18T19:19:55.613Z
Learning: Applies to packages/thirdweb/src/wallets/** : Support for in-app wallets (social/email login)
Learnt from: CR
PR: thirdweb-dev/js#0
File: CLAUDE.md:0-0
Timestamp: 2025-07-18T19:19:55.613Z
Learning: Applies to apps/{dashboard,playground-web}/**/*.{ts,tsx} : Client Components (browser): Begin files with 'use client';
Learnt from: CR
PR: thirdweb-dev/js#0
File: CLAUDE.md:0-0
Timestamp: 2025-07-18T19:19:55.613Z
Learning: Applies to packages/thirdweb/src/wallets/** : Unified Wallet
and Account
interfaces in wallet architecture
Learnt from: gregfromstl
PR: #7450
File: packages/thirdweb/src/bridge/Webhook.ts:57-81
Timestamp: 2025-06-26T19:46:04.024Z
Learning: In the onramp webhook schema (packages/thirdweb/src/bridge/Webhook.ts
), the currencyAmount
field is intentionally typed as z.number()
while other amount fields use z.string()
because currencyAmount
represents fiat currency amounts in decimals (like $10.50), whereas other amount fields represent token amounts in wei (very large integers that benefit from bigint representation). The different naming convention (currencyAmount
vs amount
) reflects this intentional distinction.
Learnt from: CR
PR: thirdweb-dev/js#0
File: .cursor/rules/dashboard.mdc:0-0
Timestamp: 2025-07-18T19:20:32.530Z
Learning: Applies to dashboard/**/*client.tsx : Anything that consumes hooks from @tanstack/react-query
or thirdweb SDKs.
🪛 LanguageTool
apps/portal/src/app/typescript/v5/connecting-wallets/page.mdx
[grammar] ~13-~13: Ensure spelling is correct
Context: ...ipt", }, title: "Connecting Wallets | TypeScriot SDK", description: "Learn how to con...
(QB_NEW_EN_ORTHOGRAPHY_ERROR_IDS_1)
⏰ Context from checks skipped due to timeout of 90000ms. You can increase the timeout in your CodeRabbit configuration to a maximum of 15 minutes (900000ms). (8)
- GitHub Check: E2E Tests (pnpm, esbuild)
- GitHub Check: E2E Tests (pnpm, webpack)
- GitHub Check: E2E Tests (pnpm, vite)
- GitHub Check: Unit Tests
- GitHub Check: Lint Packages
- GitHub Check: Build Packages
- GitHub Check: Size
- GitHub Check: Analyze (javascript)
🔇 Additional comments (1)
apps/portal/src/app/typescript/v5/connecting-wallets/page.mdx (1)
28-28
: Consistency checkLine already uses “the TypeScript SDK”; once the previous nit-pick is applied, wording across the file will be consistent. No further action needed.
Merge activity
|
``` <!-- ## title your PR with this format: "[SDK/Dashboard/Portal] Feature/Fix: Concise title for the changes" [Portal] Fix: Update SDK title for TypeScript reference pages If you did not copy the branch name from Linear, paste the issue tag here (format is TEAM-0000): ## Notes for the reviewer Updates the SDK title displayed on TypeScript reference pages from "Connect SDK" to "TypeScript SDK" for improved clarity and accuracy. ## How to test Navigate to any `/references/typescript/v*/` page (e.g., `/references/typescript/v5/`). Verify the header displays "TypeScript SDK". --> ``` --- **Open Background Agent:** [Web](https://www.cursor.com/agents?id=bc-2dec36af-4b62-431c-b277-891c1b46bb48) · [Cursor](https://cursor.com/background-agent?bcId=bc-2dec36af-4b62-431c-b277-891c1b46bb48) [Slack Thread](https://thirdwebdev.slack.com/archives/C04DYC3G5NZ/p1753110978408999?thread_ts=1753110978.408999&cid=C04DYC3G5NZ) Learn more about [Background Agents](https://docs.cursor.com/background-agents) <!-- start pr-codex --> --- ## PR-Codex overview This PR focuses on renaming references from `Connect SDK` to `TypeScript SDK` and `thirdweb SDK` across multiple files in the project, enhancing clarity and consistency in the documentation and codebase. ### Detailed summary - Updated `label` from `Connect SDKs` to `thirdweb SDKs`. - Changed `name` from `Connect SDK` to `TypeScript SDK`. - Modified `sdkTitle` from `Connect SDK` to `TypeScript SDK`. - Adjusted example descriptions and titles to reflect `TypeScript SDK`. - Updated installation instructions to refer to `TypeScript SDK`. - Revised descriptions related to wallet support to mention `thirdweb SDKs`. - Changed references in guides and documentation from `Connect SDK` to `TypeScript SDK`. > ✨ Ask PR-Codex anything about this PR by commenting with `/codex {your question}` <!-- end pr-codex --> <!-- This is an auto-generated comment: release notes by coderabbit.ai --> ## Summary by CodeRabbit * **New Features** * Updated SDK naming from "Connect SDK" to "TypeScript SDK" and "thirdweb SDK" across documentation, guides, UI labels, and sidebar links for improved clarity and consistency. * **Chores** * Removed the "Engine" API link from the main navigation header. <!-- end of auto-generated comment: release notes by coderabbit.ai -->
d7fcd04
to
ecf6dbf
Compare
Open Background Agent:
Web · Cursor
Slack Thread
Learn more about Background Agents
PR-Codex overview
This PR focuses on renaming references from
Connect SDK
toTypeScript SDK
andthirdweb SDK
across various files to improve clarity and consistency in documentation and code.Detailed summary
label
fromConnect SDKs
tothirdweb SDKs
inindex.tsx
.name
fromConnect SDK
toTypeScript SDK
insidebar.tsx
.sdkTitle
fromConnect SDK
toTypeScript SDK
inlayout.tsx
.Connect SDK example
withTypeScript SDK example
inTransactionSimulator.tsx
.Connect SDK
tothirdweb SDK
incode-overview.tsx
.Connect SDK
toTypeScript SDK
in multiple markdown files.Connect SDK
tothirdweb SDK
orTypeScript SDK
in various markdown files.TypeScript SDK
.Summary by CodeRabbit
New Features
Chores