Skip to content

docs(portal): fix syntax and compilation errors in v5 guide snippets - #8854

Open
TanmayDagur wants to merge 1 commit into
thirdweb-dev:mainfrom
TanmayDagur:fix/portal-code-snippets
Open

docs(portal): fix syntax and compilation errors in v5 guide snippets#8854
TanmayDagur wants to merge 1 commit into
thirdweb-dev:mainfrom
TanmayDagur:fix/portal-code-snippets

Conversation

@TanmayDagur

@TanmayDagur TanmayDagur commented Jul 27, 2026

Copy link
Copy Markdown

docs(portal): fix syntax and compilation errors in v5 guide snippets

What

This PR fixes critical syntax and compilation errors in the code examples on the Getting Started and Auth landing pages in the documentation portal.

Why

Currently, copying and pasting the official snippets results in direct compilation or runtime errors:

  • getting-started/page.mdx referenced an undefined TEST_CLIENT variable and passed an invalid type to getWalletBalance (missing client parameter and passing account instead of address).
  • auth/page.mdx contained a syntax error (semicolon inside an object literal) and used an undefined client variable (should be thirdwebClient).

Changes

  • Updated getting-started/page.mdx wallet connect example and getWalletBalance signature.
  • Fixed typo semicolon and renamed client to thirdwebClient in auth/page.mdx.

PR-Codex overview

This PR focuses on updating the authentication and wallet connection logic in the application, ensuring that the correct client and parameters are used for creating the thirdwebClient and fetching wallet balances.

Detailed summary

  • Changed the instantiation of thirdwebClient to use a comma instead of a semicolon.
  • Updated the adminAccount parameter in createAuth to use thirdwebClient.
  • Modified the wallet connection to use the client variable directly.
  • Adjusted the getWalletBalance call to include address: account.address.

✨ Ask PR-Codex anything about this PR by commenting with /codex {your question}

Summary by CodeRabbit

  • Documentation
    • Updated TypeScript v5 authentication examples with the current secret key and admin account configuration.
    • Refined getting-started wallet examples to use the current client setup and wallet balance parameters.

@TanmayDagur
TanmayDagur requested review from a team as code owners July 27, 2026 10:46
@changeset-bot

changeset-bot Bot commented Jul 27, 2026

Copy link
Copy Markdown

⚠️ No Changeset found

Latest commit: 85754fa

Merging this PR will not cause a version bump for any packages. If these changes should not result in a new version, you're good to go. If these changes should result in a version bump, you need to add a changeset.

This PR includes no changesets

When changesets are added to this PR, you'll see the packages that this PR includes changesets for and the associated semver types

Click here to learn what changesets are, and how to add one.

Click here if you're a maintainer who wants to add a changeset to this PR

@github-actions github-actions Bot added the Portal Involves changes to the Portal (docs) codebase. label Jul 27, 2026
@coderabbitai

coderabbitai Bot commented Jul 27, 2026

Copy link
Copy Markdown
Contributor

Review Change Stack

No actionable comments were generated in the recent review. 🎉

ℹ️ Recent review info
⚙️ Run configuration

Configuration used: Organization UI

Review profile: CHILL

Plan: Pro Plus

Run ID: 2906dd47-4760-4051-952e-07a5abd5770e

📥 Commits

Reviewing files that changed from the base of the PR and between 8c521aa and 85754fa.

📒 Files selected for processing (2)
  • apps/portal/src/app/typescript/v5/auth/page.mdx
  • apps/portal/src/app/typescript/v5/getting-started/page.mdx

Walkthrough

Updated TypeScript v5 MDX examples for Auth configuration, in-app wallet connection, and wallet balance retrieval.

Changes

TypeScript v5 documentation examples

Layer / File(s) Summary
Authentication configuration example
apps/portal/src/app/typescript/v5/auth/page.mdx
The createAuth example adds secretKey and passes thirdwebClient when constructing adminAccount.
Getting-started wallet examples
apps/portal/src/app/typescript/v5/getting-started/page.mdx
Wallet connection uses client, and getWalletBalance receives client with account.address.

Estimated code review effort: 1 (Trivial) | ~5 minutes

Possibly related PRs

Suggested reviewers: 0xfirekeeper, jakeloo

🚥 Pre-merge checks | ✅ 5
✅ Passed checks (5 passed)
Check name Status Explanation
Title check ✅ Passed The title accurately summarizes the main docs fix: correcting syntax and compilation errors in v5 portal snippets.
Description check ✅ Passed The description covers what, why, and changes; it is mostly complete even though reviewer notes and test steps are omitted.
Docstring Coverage ✅ Passed No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.
Linked Issues check ✅ Passed Check skipped because no linked issues were found for this pull request.
Out of Scope Changes check ✅ Passed Check skipped because no linked issues were found for this pull request.
✨ Finishing Touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share

Comment @coderabbitai help to get the list of available commands.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

Portal Involves changes to the Portal (docs) codebase.

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant