Skip to content

[portal] add new support article #7595

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

Merged
merged 1 commit into from
Jul 15, 2025
Merged

Conversation

GiselleNessi
Copy link
Contributor

@GiselleNessi GiselleNessi commented Jul 11, 2025


PR-Codex overview

This PR focuses on updating the documentation for bulk updating NFT metadata in thirdweb contracts, providing a step-by-step guide on how to fix metadata errors efficiently.

Detailed summary

  • Added new entries to the sidebar for "Bulk update NFT metadata".
  • Created a detailed guide in page.mdx on how to use updateBatchBaseURI.
  • Included steps for identifying, downloading, editing, and re-uploading NFT metadata.
  • Added images to illustrate the process.

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

Summary by CodeRabbit

  • New Features

    • Added a new sidebar entry for "Bulk update NFT metadata" under the "Contracts" section in the Troubleshoot category.
    • Introduced a comprehensive step-by-step guide on how to update metadata for multiple NFTs in bulk, including instructions, images, and helpful resources.
  • Documentation

    • Expanded the knowledge base with detailed troubleshooting documentation for bulk updating NFT metadata.

@GiselleNessi GiselleNessi self-assigned this Jul 11, 2025
@GiselleNessi GiselleNessi requested review from a team as code owners July 11, 2025 11:41
Copy link

changeset-bot bot commented Jul 11, 2025

⚠️ No Changeset found

Latest commit: 761cde6

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

Copy link

vercel bot commented Jul 11, 2025

The latest updates on your projects. Learn more about Vercel for Git ↗︎

Name Status Preview Comments Updated (UTC)
docs-v2 ✅ Ready (Inspect) Visit Preview 💬 Add feedback Jul 15, 2025 4:57pm
4 Skipped Deployments
Name Status Preview Comments Updated (UTC)
nebula ⬜️ Skipped (Inspect) Jul 15, 2025 4:57pm
thirdweb_playground ⬜️ Skipped (Inspect) Jul 15, 2025 4:57pm
thirdweb-www ⬜️ Skipped (Inspect) Jul 15, 2025 4:57pm
wallet-ui ⬜️ Skipped (Inspect) Jul 15, 2025 4:57pm

Copy link
Contributor

coderabbitai bot commented Jul 11, 2025

Walkthrough

A new knowledge base article was added, providing a step-by-step guide for bulk updating NFT metadata in NFTDrop (ERC-721A) contracts. Additionally, the sidebar configuration was updated to include a link to this new guide under the "Troubleshoot" section for contracts.

Changes

File(s) Change Summary
apps/portal/src/app/knowledge-base/sidebar.tsx Added a new sidebar entry: "Bulk update NFT metadata" under "Troubleshoot > Contracts".
apps/portal/src/app/knowledge-base/troubleshoot/contracts/update-nft-metadata/page.mdx Added a detailed MDX guide on bulk updating NFT metadata for NFTDrop contracts.

Sequence Diagram(s)

sequenceDiagram
    participant User
    participant KnowledgeBase (Portal)
    participant NFTDrop Contract
    participant IPFS/thirdweb Storage

    User->>KnowledgeBase (Portal): Access "Bulk update NFT metadata" guide
    User->>NFTDrop Contract: Query tokenURI for a token in batch
    User->>IPFS/thirdweb Storage: Download current metadata files
    User->>User: Edit metadata files locally
    User->>IPFS/thirdweb Storage: Upload corrected metadata folder
    User->>NFTDrop Contract: Call updateBatchBaseURI(batchId, newBaseURI)
    NFTDrop Contract-->>User: Metadata for batch updated
Loading

Warning

Review ran into problems

🔥 Problems

Errors were encountered while retrieving linked issues.

Errors (1)
  • TEAM-0000: Entity not found: Issue - Could not find referenced Issue.
✨ Finishing Touches
  • 📝 Generate Docstrings

🪧 Tips

Chat

There are 3 ways to chat with CodeRabbit:

  • Review comments: Directly reply to a review comment made by CodeRabbit. Example:
    • I pushed a fix in commit <commit_id>, please review it.
    • Explain this complex logic.
    • Open a follow-up GitHub issue for this discussion.
  • Files and specific lines of code (under the "Files changed" tab): Tag @coderabbitai in a new review comment at the desired location with your query. Examples:
    • @coderabbitai explain this code block.
    • @coderabbitai modularize this function.
  • PR comments: Tag @coderabbitai in a new PR comment to ask questions about the PR branch. For the best results, please provide a very specific query, as very limited context is provided in this mode. Examples:
    • @coderabbitai gather interesting stats about this repository and render them as a table. Additionally, render a pie chart showing the language distribution in the codebase.
    • @coderabbitai read src/utils.ts and explain its main purpose.
    • @coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.
    • @coderabbitai help me debug CodeRabbit configuration file.

Support

Need 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)

  • @coderabbitai pause to pause the reviews on a PR.
  • @coderabbitai resume to resume the paused reviews.
  • @coderabbitai review to trigger an incremental review. This is useful when automatic reviews are disabled for the repository.
  • @coderabbitai full review to do a full review from scratch and review all the files again.
  • @coderabbitai summary to regenerate the summary of the PR.
  • @coderabbitai generate docstrings to generate docstrings for this PR.
  • @coderabbitai generate sequence diagram to generate a sequence diagram of the changes in this PR.
  • @coderabbitai resolve resolve all the CodeRabbit review comments.
  • @coderabbitai configuration to show the current CodeRabbit configuration for the repository.
  • @coderabbitai help to get help.

Other keywords and placeholders

  • Add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.
  • Add @coderabbitai summary to generate the high-level summary at a specific location in the PR description.
  • Add @coderabbitai anywhere in the PR title to generate the title automatically.

CodeRabbit Configuration File (.coderabbit.yaml)

  • You can programmatically configure CodeRabbit by adding a .coderabbit.yaml file to the root of your repository.
  • Please see the configuration documentation for more information.
  • If your editor has YAML language server enabled, you can add the path at the top of this file to enable auto-completion and validation: # yaml-language-server: $schema=https://coderabbit.ai/integrations/schema.v2.json

Documentation and Community

  • Visit our Documentation for detailed information on how to use CodeRabbit.
  • Join our Discord Community to get help, request features, and share feedback.
  • Follow us on X/Twitter for updates and announcements.

Copy link
Contributor

graphite-app bot commented Jul 11, 2025

How to use the Graphite Merge Queue

Add either label to this PR to merge it via the merge queue:

  • merge-queue - adds this PR to the back of the merge queue
  • hotfix - for urgent hot fixes, skip the queue and merge this PR next

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.

@github-actions github-actions bot added the Portal Involves changes to the Portal (docs) codebase. label Jul 11, 2025
Copy link
Contributor

@coderabbitai coderabbitai bot left a 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 (3)
apps/portal/src/app/knowledge-base/troubleshoot/contracts/update-nft-metadata/page.mdx (3)

29-29: Convert bare URL to Markdown link for accessibility

Bare links are not keyboard-navigable in some MDX renderers and break line-wrapping. Wrap the blog URL in proper Markdown syntax:

-Checkout this guide: https://blog.thirdweb.com/changelog/updateable-nft-metadata-in-dashboard/
+Checkout this guide: [thirdweb Dashboard metadata update guide](https://blog.thirdweb.com/changelog/updateable-nft-metadata-in-dashboard/)

116-118: Minor grammar / typo

your should be ableyou should be able.

-At this point, your should be able to download a compressed file
+At this point, you should be able to download a compressed file

150-150: Grammar fix for clarity

That new namesThe new names.

-That new names for the NFTs should be reflected in a short while.
+The new names for the NFTs should be reflected in a short while.
📜 Review details

Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between f33e31a and 2c36c04.

⛔ Files ignored due to path filters (7)
  • apps/portal/src/app/knowledge-base/assets/base-uri.png is excluded by !**/*.png
  • apps/portal/src/app/knowledge-base/assets/donwload-ipfs.png is excluded by !**/*.png
  • apps/portal/src/app/knowledge-base/assets/import-ipfs.png is excluded by !**/*.png
  • apps/portal/src/app/knowledge-base/assets/search.png is excluded by !**/*.png
  • apps/portal/src/app/knowledge-base/assets/storage.png is excluded by !**/*.png
  • apps/portal/src/app/knowledge-base/assets/token-uri.png is excluded by !**/*.png
  • apps/portal/src/app/knowledge-base/assets/update-batch.png is excluded by !**/*.png
📒 Files selected for processing (2)
  • apps/portal/src/app/knowledge-base/sidebar.tsx (1 hunks)
  • apps/portal/src/app/knowledge-base/troubleshoot/contracts/update-nft-metadata/page.mdx (1 hunks)
🧰 Additional context used
📓 Path-based instructions (1)
`**/*.{ts,tsx}`: Write idiomatic TypeScript with explicit function declarations ...

**/*.{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 local types.ts barrels
Prefer type aliases over interface except for nominal shapes
Avoid any and unknown 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
Load heavy dependencies inside async paths to keep initial bundle lean (lazy loading)

📄 Source: CodeRabbit Inference Engine (CLAUDE.md)

List of files the instruction was applied to:

  • apps/portal/src/app/knowledge-base/sidebar.tsx
🧠 Learnings (2)
📓 Common learnings
Learnt from: MananTank
PR: thirdweb-dev/js#7332
File: apps/dashboard/src/app/(app)/(dashboard)/(chain)/[chain_id]/[contractAddress]/public-pages/nft/overview/nft-drop-claim.tsx:170-178
Timestamp: 2025-06-13T13:50:08.622Z
Learning: In event-tracking (`useTrack`) calls across the dashboard, the team intentionally keeps `contractType` generic as `"NFTCollection"` even for ERC-721 drops; contract differentiation is handled via the `ercType` field instead.
apps/portal/src/app/knowledge-base/sidebar.tsx (8)
Learnt from: CR
PR: thirdweb-dev/js#0
File: CLAUDE.md:0-0
Timestamp: 2025-06-30T10:25:29.489Z
Learning: Applies to src/extensions/**/*.{ts,tsx} : Auto-generated contracts from ABI definitions in extensions
Learnt from: MananTank
PR: thirdweb-dev/js#7434
File: apps/dashboard/src/app/(app)/team/~/~/contract/[chain]/[contractAddress]/components/project-selector.tsx:62-76
Timestamp: 2025-06-24T21:38:03.155Z
Learning: In the project-selector.tsx component for contract imports, the addToProject.mutate() call is intentionally not awaited (fire-and-forget pattern) to allow immediate navigation to the contract page while the import happens in the background. This is a deliberate design choice to prioritize user experience.
Learnt from: MananTank
PR: thirdweb-dev/js#7152
File: apps/dashboard/src/app/(app)/(dashboard)/(chain)/[chain_id]/[contractAddress]/tokens/shared-page.tsx:41-48
Timestamp: 2025-05-26T16:28:50.772Z
Learning: The `projectMeta` prop is not required for the server-rendered `ContractTokensPage` component in the tokens shared page, unlike some other shared pages where it's needed for consistency.
Learnt from: MananTank
PR: thirdweb-dev/js#7315
File: apps/dashboard/src/app/(app)/team/[team_slug]/[project_slug]/(sidebar)/assets/create/nft/launch-nft.tsx:153-226
Timestamp: 2025-06-10T00:50:20.795Z
Learning: In apps/dashboard/src/app/(app)/team/[team_slug]/[project_slug]/(sidebar)/assets/create/nft/launch-nft.tsx, the updateStatus function correctly expects a complete MultiStepState["status"] object. For pending states, { type: "pending" } is the entire status object. For error states, { type: "error", message: React.ReactNode } is the entire status object. The current code incorrectly spreads the entire step object instead of passing just the status object.
Learnt from: MananTank
PR: thirdweb-dev/js#7315
File: apps/dashboard/src/app/(app)/team/[team_slug]/[project_slug]/(sidebar)/assets/create/nft/launch-nft.tsx:155-160
Timestamp: 2025-06-10T00:46:58.580Z
Learning: In the dashboard application, the route structure for team and project navigation is `/team/[team_slug]/[project_slug]/...` without a `/project/` segment. Contract links should be formatted as `/team/${teamSlug}/${projectSlug}/contract/${chainId}/${contractAddress}`.
Learnt from: MananTank
PR: thirdweb-dev/js#7152
File: apps/dashboard/src/app/(app)/(dashboard)/(chain)/[chain_id]/[contractAddress]/(marketplace)/direct-listings/shared-direct-listings-page.tsx:47-52
Timestamp: 2025-05-26T16:29:54.317Z
Learning: The `projectMeta` prop is not required for the server-rendered `ContractDirectListingsPage` component in the direct listings shared page, following the same pattern as other server components in the codebase where `projectMeta` is only needed for client components.
Learnt from: MananTank
PR: thirdweb-dev/js#7332
File: apps/dashboard/src/app/(app)/(dashboard)/(chain)/[chain_id]/[contractAddress]/public-pages/nft/overview/nft-drop-claim.tsx:170-178
Timestamp: 2025-06-13T13:50:08.622Z
Learning: In event-tracking (`useTrack`) calls across the dashboard, the team intentionally keeps `contractType` generic as `"NFTCollection"` even for ERC-721 drops; contract differentiation is handled via the `ercType` field instead.
Learnt from: MananTank
PR: thirdweb-dev/js#7177
File: apps/dashboard/src/app/(app)/(dashboard)/(chain)/[chain_id]/[contractAddress]/public-pages/erc20/erc20.tsx:15-17
Timestamp: 2025-05-27T19:54:55.885Z
Learning: The `fetchDashboardContractMetadata` function from "@3rdweb-sdk/react/hooks/useDashboardContractMetadata" has internal error handlers for all promises and cannot throw errors, so external error handling is not needed when calling this function.
🪛 LanguageTool
apps/portal/src/app/knowledge-base/troubleshoot/contracts/update-nft-metadata/page.mdx

[style] ~45-~45: ‘end result’ might be wordy. Consider a shorter alternative.
Context: ...0,000 items to an NFTDrop contract, the end result would look like this: ```tsx ipfs://Qm...

(EN_WORDINESS_PREMIUM_END_RESULT)

⏰ 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: Size
  • GitHub Check: E2E Tests (pnpm, esbuild)
  • GitHub Check: Build Packages
  • GitHub Check: E2E Tests (pnpm, webpack)
  • GitHub Check: Unit Tests
  • GitHub Check: E2E Tests (pnpm, vite)
  • GitHub Check: Lint Packages
  • GitHub Check: Analyze (javascript)
🔇 Additional comments (1)
apps/portal/src/app/knowledge-base/sidebar.tsx (1)

78-81: LGTM – link wired correctly

The new Troubleshoot → Contracts entry points to the correct MDX route and follows the existing sidebar object structure. No further action required.

Copy link

codecov bot commented Jul 11, 2025

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 56.42%. Comparing base (9546b92) to head (761cde6).
Report is 1 commits behind head on main.

Additional details and impacted files
@@           Coverage Diff           @@
##             main    #7595   +/-   ##
=======================================
  Coverage   56.42%   56.42%           
=======================================
  Files         906      906           
  Lines       58126    58126           
  Branches     4224     4224           
=======================================
  Hits        32796    32796           
  Misses      25222    25222           
  Partials      108      108           
Flag Coverage Δ
packages 56.42% <ø> (ø)
🚀 New features to boost your workflow:
  • ❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.
  • 📦 JS Bundle Analysis: Save yourself from yourself by tracking and limiting bundle sizes in JS merges.

Copy link
Contributor

github-actions bot commented Jul 11, 2025

size-limit report 📦

Path Size Loading time (3g) Running time (snapdragon) Total time
thirdweb (esm) 63.25 KB (0%) 1.3 s (0%) 362 ms (+202.29% 🔺) 1.7 s
thirdweb (cjs) 353.31 KB (0%) 7.1 s (0%) 1.1 s (+13% 🔺) 8.2 s
thirdweb (minimal + tree-shaking) 5.7 KB (0%) 114 ms (0%) 138 ms (+1803.6% 🔺) 252 ms
thirdweb/chains (tree-shaking) 526 B (0%) 11 ms (0%) 76 ms (+3469.2% 🔺) 86 ms
thirdweb/react (minimal + tree-shaking) 19.59 KB (0%) 392 ms (0%) 115 ms (+636.36% 🔺) 507 ms

@vercel vercel bot temporarily deployed to Preview – thirdweb_playground July 11, 2025 11:47 Inactive
@vercel vercel bot temporarily deployed to Preview – nebula July 11, 2025 11:47 Inactive
@vercel vercel bot temporarily deployed to Preview – wallet-ui July 11, 2025 11:47 Inactive
@vercel vercel bot temporarily deployed to Preview – thirdweb-www July 11, 2025 11:47 Inactive
Copy link
Contributor

@coderabbitai coderabbitai bot left a 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

♻️ Duplicate comments (1)
apps/portal/src/app/knowledge-base/troubleshoot/contracts/update-nft-metadata/page.mdx (1)

57-58: Duplicate: replace “a same folder” with “the same folder”

This grammar issue was already pointed out in a previous review comment; apply the fix to keep wording consistent.

-***These first 10,000 items’ metadata files are uploaded in a same folder on IPFS,
+***These first 10,000 items’ metadata files are uploaded in the same folder on IPFS,
🧹 Nitpick comments (3)
apps/portal/src/app/knowledge-base/troubleshoot/contracts/update-nft-metadata/page.mdx (3)

21-26: Fix grammar inside the metadata example

“belong” → “belongs”.

-  description: "This NFT belong to the Crypto Cats collection",
+  description: "This NFT belongs to the Crypto Cats collection",

29-30: Spelling: “Checkout” → “Check out”

Small copy tweak for correctness.

-Now, if only you have made the typo on a few items, you can use the thirdweb Dashboard to manually update the metadata on those few. Checkout this guide: …
+Now, if you only made the typo on a few items, you can use the thirdweb Dashboard to update those manually. Check out this guide: …

149-150: Typo: “That new names” → “The new names”

-… and hit Execute. That new names for the NFTs should be reflected in a short while.
+… and hit Execute. The new names for the NFTs should be reflected shortly.
📜 Review details

Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between 2c36c04 and e0fde6d.

⛔ Files ignored due to path filters (1)
  • apps/portal/src/app/knowledge-base/assets/download-ipfs.png is excluded by !**/*.png
📒 Files selected for processing (1)
  • apps/portal/src/app/knowledge-base/troubleshoot/contracts/update-nft-metadata/page.mdx (1 hunks)
🧰 Additional context used
🧠 Learnings (2)
📓 Common learnings
Learnt from: CR
PR: thirdweb-dev/js#0
File: CLAUDE.md:0-0
Timestamp: 2025-06-30T10:25:29.488Z
Learning: Surface breaking changes prominently in PR descriptions
Learnt from: MananTank
PR: thirdweb-dev/js#7332
File: apps/dashboard/src/app/(app)/(dashboard)/(chain)/[chain_id]/[contractAddress]/public-pages/nft/overview/nft-drop-claim.tsx:170-178
Timestamp: 2025-06-13T13:50:08.622Z
Learning: In event-tracking (`useTrack`) calls across the dashboard, the team intentionally keeps `contractType` generic as `"NFTCollection"` even for ERC-721 drops; contract differentiation is handled via the `ercType` field instead.
apps/portal/src/app/knowledge-base/troubleshoot/contracts/update-nft-metadata/page.mdx (9)
Learnt from: saminacodes
PR: thirdweb-dev/js#7543
File: apps/portal/src/app/pay/page.mdx:4-4
Timestamp: 2025-07-07T21:21:47.488Z
Learning: In the thirdweb-dev/js repository, lucide-react icons must be imported with the "Icon" suffix (e.g., ExternalLinkIcon, RocketIcon) as required by the new linting rule, contrary to the typical lucide-react convention of importing without the suffix.
Learnt from: MananTank
PR: thirdweb-dev/js#7315
File: apps/dashboard/src/app/(app)/team/[team_slug]/[project_slug]/(sidebar)/assets/create/nft/launch-nft.tsx:153-226
Timestamp: 2025-06-10T00:50:20.795Z
Learning: In apps/dashboard/src/app/(app)/team/[team_slug]/[project_slug]/(sidebar)/assets/create/nft/launch-nft.tsx, the updateStatus function correctly expects a complete MultiStepState["status"] object. For pending states, { type: "pending" } is the entire status object. For error states, { type: "error", message: React.ReactNode } is the entire status object. The current code incorrectly spreads the entire step object instead of passing just the status object.
Learnt from: CR
PR: thirdweb-dev/js#0
File: .cursor/rules/dashboard.mdc:0-0
Timestamp: 2025-06-30T10:26:04.389Z
Learning: Applies to dashboard/**/components/**/*.{ts,tsx} : Icons come from `lucide-react` or the project-specific `…/icons` exports – never embed raw SVG.
Learnt from: MananTank
PR: thirdweb-dev/js#7434
File: apps/dashboard/src/app/(app)/team/~/~/contract/[chain]/[contractAddress]/components/project-selector.tsx:62-76
Timestamp: 2025-06-24T21:38:03.155Z
Learning: In the project-selector.tsx component for contract imports, the addToProject.mutate() call is intentionally not awaited (fire-and-forget pattern) to allow immediate navigation to the contract page while the import happens in the background. This is a deliberate design choice to prioritize user experience.
Learnt from: CR
PR: thirdweb-dev/js#0
File: CLAUDE.md:0-0
Timestamp: 2025-06-30T10:25:29.488Z
Learning: Applies to apps/{dashboard,playground-web}/**/*.{tsx,ts} : 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-06-30T10:25:29.488Z
Learning: Applies to apps/{dashboard,playground-web}/**/*.{tsx,ts} : Server Components (Node edge): Start files with `import "server-only";`
Learnt from: CR
PR: thirdweb-dev/js#0
File: CLAUDE.md:0-0
Timestamp: 2025-06-30T10:25:29.488Z
Learning: Applies to apps/{dashboard,playground-web}/**/*.{tsx,ts} : Import UI primitives from `@/components/ui/*` (Button, Input, Select, Tabs, Card, Sidebar, Badge, Separator) in dashboard and playground apps
Learnt from: MananTank
PR: thirdweb-dev/js#7315
File: apps/dashboard/src/app/(app)/team/[team_slug]/[project_slug]/(sidebar)/assets/create/nft/form.ts:12-14
Timestamp: 2025-06-10T00:55:19.140Z
Learning: The NFT collection form (`nftCollectionInfoFormSchema`) in `apps/dashboard/src/app/(app)/team/[team_slug]/[project_slug]/(sidebar)/assets/create/nft/form.ts` is intentionally designed to only allow File uploads for the `image` field, not hosted URLs. The schema correctly uses `z.instanceof(File).optional()` to restrict image inputs to uploaded files only.
Learnt from: CR
PR: thirdweb-dev/js#0
File: CLAUDE.md:0-0
Timestamp: 2025-06-30T10:25:29.489Z
Learning: Applies to apps/{dashboard,playground-web}/**/*.{tsx,ts} : Client Components (browser): Begin files with `'use client';`
🪛 LanguageTool
apps/portal/src/app/knowledge-base/troubleshoot/contracts/update-nft-metadata/page.mdx

[style] ~45-~45: ‘end result’ might be wordy. Consider a shorter alternative.
Context: ...0,000 items to an NFTDrop contract, the end result would look like this: ```tsx ipfs://Qm...

(EN_WORDINESS_PREMIUM_END_RESULT)

⏰ 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, webpack)
  • GitHub Check: E2E Tests (pnpm, esbuild)
  • GitHub Check: Size
  • GitHub Check: E2E Tests (pnpm, vite)
  • GitHub Check: Unit Tests
  • GitHub Check: Lint Packages
  • GitHub Check: Build Packages
  • GitHub Check: Analyze (javascript)

@vercel vercel bot temporarily deployed to Preview – nebula July 11, 2025 11:53 Inactive
@vercel vercel bot temporarily deployed to Preview – wallet-ui July 11, 2025 11:53 Inactive
@vercel vercel bot temporarily deployed to Preview – thirdweb-www July 11, 2025 11:53 Inactive
@vercel vercel bot temporarily deployed to Preview – thirdweb_playground July 11, 2025 11:53 Inactive
Copy link
Contributor

@coderabbitai coderabbitai bot left a 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

♻️ Duplicate comments (1)
apps/portal/src/app/knowledge-base/troubleshoot/contracts/update-nft-metadata/page.mdx (1)

1-1: Remove unused Step / Steps imports

Step and Steps are imported but never referenced, so eslint --max-warnings=0 will fail the build.

-import { DocImage, Step, Steps } from "@doc";
+import { DocImage } from "@doc";
🧹 Nitpick comments (5)
apps/portal/src/app/knowledge-base/troubleshoot/contracts/update-nft-metadata/page.mdx (5)

29-29: Past-perfect tense for conditional clause

Use “had made” instead of “have made”.

-Now, if only you have made the typo on a few items, you can use the thirdweb Dashboard to manually update the metadata on those few.
+Now, if you had only made the typo on a few items, you could use the thirdweb Dashboard to update those items manually.

45-45: Capitalize sentence start

Begin the second sentence with “Let’s”.

-The metadata files of those items are uploaded to IPFS in the same folder. let's say you upload the first 10,000 items to an NFTDrop contract, the end result would look like this:
+The metadata files of those items are uploaded to IPFS in the same folder. Let's say you upload the first 10,000 items to an NFTDrop contract; the result would look like this:

57-57: Use “the same folder”, not “a same folder”

-***These first 10,000 items’ metadata files are uploaded in a same folder on IPFS, so the “Base” here is `ipfs://Qm...abcxyz`***
+***These first 10,000 items’ metadata files are uploaded in the same folder on IPFS, so the “Base” here is `ipfs://Qm...abcxyz`***

150-150: Article “the” instead of “that”

-...and hit Execute. That new names for the NFTs should be reflected in a short while.
+...and hit Execute. The new names for the NFTs should be reflected shortly.

65-66: Add descriptive alt text to images for accessibility

<DocImage> components lack alt text. Provide concise descriptions for screen readers.

-<DocImage src={Batch} />
+<DocImage src={Batch} alt="updateBatchBaseURI function parameters in thirdweb Dashboard" />

Apply similar alt props to all other DocImage usages.

📜 Review details

Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between e0fde6d and aac09ef.

📒 Files selected for processing (1)
  • apps/portal/src/app/knowledge-base/troubleshoot/contracts/update-nft-metadata/page.mdx (1 hunks)
🧰 Additional context used
🧠 Learnings (2)
📓 Common learnings
Learnt from: CR
PR: thirdweb-dev/js#0
File: CLAUDE.md:0-0
Timestamp: 2025-06-30T10:25:29.488Z
Learning: Surface breaking changes prominently in PR descriptions
Learnt from: MananTank
PR: thirdweb-dev/js#7332
File: apps/dashboard/src/app/(app)/(dashboard)/(chain)/[chain_id]/[contractAddress]/public-pages/nft/overview/nft-drop-claim.tsx:170-178
Timestamp: 2025-06-13T13:50:08.622Z
Learning: In event-tracking (`useTrack`) calls across the dashboard, the team intentionally keeps `contractType` generic as `"NFTCollection"` even for ERC-721 drops; contract differentiation is handled via the `ercType` field instead.
apps/portal/src/app/knowledge-base/troubleshoot/contracts/update-nft-metadata/page.mdx (13)
Learnt from: saminacodes
PR: thirdweb-dev/js#7543
File: apps/portal/src/app/pay/page.mdx:4-4
Timestamp: 2025-07-07T21:21:47.488Z
Learning: In the thirdweb-dev/js repository, lucide-react icons must be imported with the "Icon" suffix (e.g., ExternalLinkIcon, RocketIcon) as required by the new linting rule, contrary to the typical lucide-react convention of importing without the suffix.
Learnt from: MananTank
PR: thirdweb-dev/js#7315
File: apps/dashboard/src/app/(app)/team/[team_slug]/[project_slug]/(sidebar)/assets/create/nft/launch-nft.tsx:153-226
Timestamp: 2025-06-10T00:50:20.795Z
Learning: In apps/dashboard/src/app/(app)/team/[team_slug]/[project_slug]/(sidebar)/assets/create/nft/launch-nft.tsx, the updateStatus function correctly expects a complete MultiStepState["status"] object. For pending states, { type: "pending" } is the entire status object. For error states, { type: "error", message: React.ReactNode } is the entire status object. The current code incorrectly spreads the entire step object instead of passing just the status object.
Learnt from: CR
PR: thirdweb-dev/js#0
File: .cursor/rules/dashboard.mdc:0-0
Timestamp: 2025-06-30T10:26:04.389Z
Learning: Applies to dashboard/**/components/**/*.{ts,tsx} : Icons come from `lucide-react` or the project-specific `…/icons` exports – never embed raw SVG.
Learnt from: MananTank
PR: thirdweb-dev/js#7434
File: apps/dashboard/src/app/(app)/team/~/~/contract/[chain]/[contractAddress]/components/project-selector.tsx:62-76
Timestamp: 2025-06-24T21:38:03.155Z
Learning: In the project-selector.tsx component for contract imports, the addToProject.mutate() call is intentionally not awaited (fire-and-forget pattern) to allow immediate navigation to the contract page while the import happens in the background. This is a deliberate design choice to prioritize user experience.
Learnt from: CR
PR: thirdweb-dev/js#0
File: CLAUDE.md:0-0
Timestamp: 2025-06-30T10:25:29.488Z
Learning: Applies to apps/{dashboard,playground-web}/**/*.{tsx,ts} : 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-06-30T10:25:29.488Z
Learning: Applies to apps/{dashboard,playground-web}/**/*.{tsx,ts} : Server Components (Node edge): Start files with `import "server-only";`
Learnt from: MananTank
PR: thirdweb-dev/js#7315
File: apps/dashboard/src/app/(app)/team/[team_slug]/[project_slug]/(sidebar)/assets/create/nft/form.ts:12-14
Timestamp: 2025-06-10T00:55:19.140Z
Learning: The NFT collection form (`nftCollectionInfoFormSchema`) in `apps/dashboard/src/app/(app)/team/[team_slug]/[project_slug]/(sidebar)/assets/create/nft/form.ts` is intentionally designed to only allow File uploads for the `image` field, not hosted URLs. The schema correctly uses `z.instanceof(File).optional()` to restrict image inputs to uploaded files only.
Learnt from: CR
PR: thirdweb-dev/js#0
File: CLAUDE.md:0-0
Timestamp: 2025-06-30T10:25:29.488Z
Learning: Applies to apps/{dashboard,playground-web}/**/*.{tsx,ts} : 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-06-30T10:25:29.489Z
Learning: Applies to src/@/analytics/report.ts : Analytics Events: Event name should be human-readable `<subject> <verb>` (e.g. "contract deployed")
Learnt from: CR
PR: thirdweb-dev/js#0
File: .cursor/rules/dashboard.mdc:0-0
Timestamp: 2025-06-30T10:26:04.389Z
Learning: Applies to dashboard/**/api/**/*.{ts,tsx} : Prefix files with `import "server-only";` so they never end up in the client bundle.
Learnt from: CR
PR: thirdweb-dev/js#0
File: CLAUDE.md:0-0
Timestamp: 2025-06-30T10:25:29.489Z
Learning: Applies to apps/{dashboard,playground-web}/**/*.{tsx,ts} : 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-06-30T10:26:04.389Z
Learning: Applies to dashboard/**/components/**/*.{ts,tsx} : Prefer composable primitives over custom markup: `Button`, `Input`, `Select`, `Tabs`, `Card`, `Sidebar`, `Separator`, `Badge`.
Learnt from: CR
PR: thirdweb-dev/js#0
File: .cursor/rules/dashboard.mdc:0-0
Timestamp: 2025-06-30T10:26:04.389Z
Learning: Applies to dashboard/**/components/**/*.{ts,tsx} : Always import from the central UI library under `@/components/ui/*` – e.g. `import { Button } from "@/components/ui/button"`.
🪛 LanguageTool
apps/portal/src/app/knowledge-base/troubleshoot/contracts/update-nft-metadata/page.mdx

[style] ~45-~45: ‘end result’ might be wordy. Consider a shorter alternative.
Context: ...0,000 items to an NFTDrop contract, the end result would look like this: ```tsx ipfs://Qm...

(EN_WORDINESS_PREMIUM_END_RESULT)

⏰ 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: Size
  • GitHub Check: Unit Tests
  • GitHub Check: E2E Tests (pnpm, vite)
  • GitHub Check: E2E Tests (pnpm, webpack)
  • GitHub Check: Build Packages
  • GitHub Check: Lint Packages
  • GitHub Check: Analyze (javascript)

@GiselleNessi GiselleNessi added the merge-queue Adds the pull request to Graphite's merge queue. label Jul 15, 2025
Copy link
Contributor Author

GiselleNessi commented Jul 15, 2025

Merge activity

<!--

## title your PR with this format: "[SDK/Dashboard/Portal] Feature/Fix: Concise title for the changes"

If you did not copy the branch name from Linear, paste the issue tag here (format is TEAM-0000):

## Notes for the reviewer

Anything important to call out? Be sure to also clarify these in your comments.

## How to test

Unit tests, playground, etc.

-->

<!-- start pr-codex -->

---

## PR-Codex overview
This PR focuses on enhancing the `knowledge-base` section by adding new assets and a comprehensive guide for bulk updating NFT metadata, specifically for ERC-721A contracts.

### Detailed summary
- Added multiple image assets to the `knowledge-base`.
- Introduced a new guide in `page.mdx` for bulk updating NFT metadata.
- Explained concepts of batch and base URI in the context of NFTs.
- Provided step-by-step instructions for updating NFT metadata efficiently.

> ✨ 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**
  * Added a new sidebar entry for "Bulk update NFT metadata" under the "Contracts" section in the Troubleshoot category.
  * Introduced a comprehensive step-by-step guide on how to update metadata for multiple NFTs in bulk, including instructions, images, and helpful resources.

* **Documentation**
  * Expanded the knowledge base with detailed troubleshooting documentation for bulk updating NFT metadata.
<!-- end of auto-generated comment: release notes by coderabbit.ai -->
@graphite-app graphite-app bot force-pushed the gi/howto-support-article branch from 64919db to 761cde6 Compare July 15, 2025 16:55
@vercel vercel bot temporarily deployed to Preview – nebula July 15, 2025 16:55 Inactive
@vercel vercel bot temporarily deployed to Preview – thirdweb_playground July 15, 2025 16:55 Inactive
@vercel vercel bot temporarily deployed to Preview – thirdweb-www July 15, 2025 16:55 Inactive
@vercel vercel bot temporarily deployed to Preview – wallet-ui July 15, 2025 16:55 Inactive
Copy link
Contributor

@coderabbitai coderabbitai bot left a 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

♻️ Duplicate comments (1)
apps/portal/src/app/knowledge-base/troubleshoot/contracts/update-nft-metadata/page.mdx (1)

1-1: Step / Steps remain unused – will fail linting
Previous feedback already pointed this out. Unless these components are added later, drop them to satisfy the portal-wide no-unused-vars rule.

-import { DocImage, Step, Steps } from "@doc";
+import { DocImage } from "@doc";
🧹 Nitpick comments (3)
apps/portal/src/app/knowledge-base/troubleshoot/contracts/update-nft-metadata/page.mdx (3)

59-59: Article grammar nit – “a unique”, not “an unique”

-For every batch ID, there will be an unique associated base URI.
+For every batch ID, there will be a unique associated base URI.

148-150: Minor wording – “The new names”

-…hit Execute. That new names for the NFTs should be reflected in a short while.
+…hit Execute. The new names for the NFTs should be reflected in a short while.

65-65: Add descriptive alt text for accessibility

DocImage accepts an alt prop (see other KB articles). Provide at least a short label so screen-reader users aren’t left out.

-  <DocImage src={Batch} />
+  <DocImage src={Batch} alt="updateBatchBaseURI function parameters in the Dashboard Explorer" />

Please replicate for all other images.

📜 Review details

Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between aac09ef and 761cde6.

⛔ Files ignored due to path filters (7)
  • apps/portal/src/app/knowledge-base/assets/base-uri.png is excluded by !**/*.png
  • apps/portal/src/app/knowledge-base/assets/download-ipfs.png is excluded by !**/*.png
  • apps/portal/src/app/knowledge-base/assets/import-ipfs.png is excluded by !**/*.png
  • apps/portal/src/app/knowledge-base/assets/search.png is excluded by !**/*.png
  • apps/portal/src/app/knowledge-base/assets/storage.png is excluded by !**/*.png
  • apps/portal/src/app/knowledge-base/assets/token-uri.png is excluded by !**/*.png
  • apps/portal/src/app/knowledge-base/assets/update-batch.png is excluded by !**/*.png
📒 Files selected for processing (2)
  • apps/portal/src/app/knowledge-base/sidebar.tsx (1 hunks)
  • apps/portal/src/app/knowledge-base/troubleshoot/contracts/update-nft-metadata/page.mdx (1 hunks)
🚧 Files skipped from review as they are similar to previous changes (1)
  • apps/portal/src/app/knowledge-base/sidebar.tsx
🧰 Additional context used
🧠 Learnings (2)
📓 Common learnings
Learnt from: MananTank
PR: thirdweb-dev/js#7332
File: apps/dashboard/src/app/(app)/(dashboard)/(chain)/[chain_id]/[contractAddress]/public-pages/nft/overview/nft-drop-claim.tsx:170-178
Timestamp: 2025-06-13T13:50:08.622Z
Learning: In event-tracking (`useTrack`) calls across the dashboard, the team intentionally keeps `contractType` generic as `"NFTCollection"` even for ERC-721 drops; contract differentiation is handled via the `ercType` field instead.
apps/portal/src/app/knowledge-base/troubleshoot/contracts/update-nft-metadata/page.mdx (13)
Learnt from: saminacodes
PR: thirdweb-dev/js#7543
File: apps/portal/src/app/pay/page.mdx:4-4
Timestamp: 2025-07-07T21:21:47.488Z
Learning: In the thirdweb-dev/js repository, lucide-react icons must be imported with the "Icon" suffix (e.g., ExternalLinkIcon, RocketIcon) as required by the new linting rule, contrary to the typical lucide-react convention of importing without the suffix.
Learnt from: MananTank
PR: thirdweb-dev/js#7315
File: apps/dashboard/src/app/(app)/team/[team_slug]/[project_slug]/(sidebar)/assets/create/nft/launch-nft.tsx:153-226
Timestamp: 2025-06-10T00:50:20.795Z
Learning: In apps/dashboard/src/app/(app)/team/[team_slug]/[project_slug]/(sidebar)/assets/create/nft/launch-nft.tsx, the updateStatus function correctly expects a complete MultiStepState["status"] object. For pending states, { type: "pending" } is the entire status object. For error states, { type: "error", message: React.ReactNode } is the entire status object. The current code incorrectly spreads the entire step object instead of passing just the status object.
Learnt from: CR
PR: thirdweb-dev/js#0
File: .cursor/rules/dashboard.mdc:0-0
Timestamp: 2025-06-30T10:26:04.389Z
Learning: Applies to dashboard/**/components/**/*.{ts,tsx} : Icons come from `lucide-react` or the project-specific `…/icons` exports – never embed raw SVG.
Learnt from: MananTank
PR: thirdweb-dev/js#7434
File: apps/dashboard/src/app/(app)/team/~/~/contract/[chain]/[contractAddress]/components/project-selector.tsx:62-76
Timestamp: 2025-06-24T21:38:03.155Z
Learning: In the project-selector.tsx component for contract imports, the addToProject.mutate() call is intentionally not awaited (fire-and-forget pattern) to allow immediate navigation to the contract page while the import happens in the background. This is a deliberate design choice to prioritize user experience.
Learnt from: CR
PR: thirdweb-dev/js#0
File: CLAUDE.md:0-0
Timestamp: 2025-06-30T10:25:29.488Z
Learning: Applies to apps/{dashboard,playground-web}/**/*.{tsx,ts} : 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-06-30T10:25:29.488Z
Learning: Applies to apps/{dashboard,playground-web}/**/*.{tsx,ts} : Server Components (Node edge): Start files with `import "server-only";`
Learnt from: MananTank
PR: thirdweb-dev/js#7315
File: apps/dashboard/src/app/(app)/team/[team_slug]/[project_slug]/(sidebar)/assets/create/nft/form.ts:12-14
Timestamp: 2025-06-10T00:55:19.140Z
Learning: The NFT collection form (`nftCollectionInfoFormSchema`) in `apps/dashboard/src/app/(app)/team/[team_slug]/[project_slug]/(sidebar)/assets/create/nft/form.ts` is intentionally designed to only allow File uploads for the `image` field, not hosted URLs. The schema correctly uses `z.instanceof(File).optional()` to restrict image inputs to uploaded files only.
Learnt from: CR
PR: thirdweb-dev/js#0
File: CLAUDE.md:0-0
Timestamp: 2025-06-30T10:25:29.488Z
Learning: Applies to apps/{dashboard,playground-web}/**/*.{tsx,ts} : 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-06-30T10:25:29.489Z
Learning: Applies to src/@/analytics/report.ts : Analytics Events: Event name should be human-readable `<subject> <verb>` (e.g. "contract deployed")
Learnt from: CR
PR: thirdweb-dev/js#0
File: .cursor/rules/dashboard.mdc:0-0
Timestamp: 2025-06-30T10:26:04.389Z
Learning: Applies to dashboard/**/api/**/*.{ts,tsx} : Prefix files with `import "server-only";` so they never end up in the client bundle.
Learnt from: CR
PR: thirdweb-dev/js#0
File: CLAUDE.md:0-0
Timestamp: 2025-06-30T10:25:29.489Z
Learning: Applies to apps/{dashboard,playground-web}/**/*.{tsx,ts} : 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-06-30T10:26:04.389Z
Learning: Applies to dashboard/**/components/**/*.{ts,tsx} : Prefer composable primitives over custom markup: `Button`, `Input`, `Select`, `Tabs`, `Card`, `Sidebar`, `Separator`, `Badge`.
Learnt from: CR
PR: thirdweb-dev/js#0
File: .cursor/rules/dashboard.mdc:0-0
Timestamp: 2025-06-30T10:26:04.389Z
Learning: Applies to dashboard/**/components/**/*.{ts,tsx} : Always import from the central UI library under `@/components/ui/*` – e.g. `import { Button } from "@/components/ui/button"`.
🪛 LanguageTool
apps/portal/src/app/knowledge-base/troubleshoot/contracts/update-nft-metadata/page.mdx

[style] ~45-~45: ‘end result’ might be wordy. Consider a shorter alternative.
Context: ...0,000 items to an NFTDrop contract, the end result would look like this: ```tsx ipfs://Qm...

(EN_WORDINESS_PREMIUM_END_RESULT)

⏰ 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, vite)
  • GitHub Check: E2E Tests (pnpm, webpack)
  • GitHub Check: Lint Packages
  • GitHub Check: Build Packages
  • GitHub Check: Unit Tests
  • GitHub Check: Size
  • GitHub Check: Analyze (javascript)

@graphite-app graphite-app bot merged commit 761cde6 into main Jul 15, 2025
23 checks passed
@graphite-app graphite-app bot deleted the gi/howto-support-article branch July 15, 2025 16:58
@graphite-app graphite-app bot removed the merge-queue Adds the pull request to Graphite's merge queue. label Jul 15, 2025
@vercel vercel bot temporarily deployed to Production – thirdweb-www July 15, 2025 16:58 Inactive
@vercel vercel bot temporarily deployed to Production – wallet-ui July 15, 2025 16:58 Inactive
@vercel vercel bot temporarily deployed to Production – thirdweb_playground July 15, 2025 16:58 Inactive
@vercel vercel bot temporarily deployed to Production – nebula July 15, 2025 16:58 Inactive
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.

2 participants