Skip to content

docs: Add docs about dedicated support channel #7399

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

Conversation

arcoraven
Copy link
Contributor

@arcoraven arcoraven commented Jun 21, 2025

[Portal] Feature: Add dedicated support page for Scale plan teams

Notes for the reviewer

Added a new page for Scale plan teams to create and manage dedicated support channels. This includes:

  • New "Get Dedicated Support" page with instructions for creating support channels
  • Updated navigation links in sidebar and account page

How to test

Navigate to the account section and verify the new support page link appears in both the sidebar and main account page. Check that the dedicated support page displays correctly with proper formatting of steps and callouts.

Summary by CodeRabbit

  • New Features

    • Added a "Get Dedicated Support" link under the "Teams" section in the account sidebar and navigation.
    • Introduced a new "Get Dedicated Support" documentation page with step-by-step instructions for teams on eligible plans to set up and manage a dedicated support channel.
  • Documentation

    • Provided detailed guidance for creating, updating, and removing dedicated support channels for teams.
  • Refactor

    • Marked certain usage tracking types and schemas as deprecated in preparation for future updates.

Copy link

vercel bot commented Jun 21, 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 Jun 21, 2025 3:17am
thirdweb-www ✅ Ready (Inspect) Visit Preview 💬 Add feedback Jun 21, 2025 3:17am
3 Skipped Deployments
Name Status Preview Comments Updated (UTC)
nebula ⬜️ Skipped (Inspect) Jun 21, 2025 3:17am
thirdweb_playground ⬜️ Skipped (Inspect) Jun 21, 2025 3:17am
wallet-ui ⬜️ Skipped (Inspect) Jun 21, 2025 3:17am

@vercel vercel bot temporarily deployed to Preview – wallet-ui June 21, 2025 03:09 Inactive
@vercel vercel bot temporarily deployed to Preview – thirdweb_playground June 21, 2025 03:09 Inactive
@vercel vercel bot temporarily deployed to Preview – nebula June 21, 2025 03:09 Inactive
Copy link

changeset-bot bot commented Jun 21, 2025

⚠️ No Changeset found

Latest commit: ad0c8e6

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.

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

💥 An error occurred when fetching the changed packages and changesets in this PR
Some errors occurred when validating the changesets config:
The package or glob expression "thirdweb-login" is specified in the `ignore` option but it is not found in the project. You may have misspelled the package name or provided an invalid glob expression. Note that glob expressions must be defined according to https://www.npmjs.com/package/micromatch.

Copy link
Contributor

coderabbitai bot commented Jun 21, 2025

Walkthrough

A new "Get Dedicated Support" feature was integrated into the portal app, including a sidebar and navigation link under "Teams" and a detailed documentation page. Additionally, deprecation annotations were added to specific usage event schema exports in the service utilities package.

Changes

File(s) Change Summary
apps/portal/src/app/account/page.mdx
apps/portal/src/app/account/sidebar.tsx
Added "Get Dedicated Support" navigation and sidebar link under the "Teams" section of the account page.
apps/portal/src/app/account/teams/get-dedicated-support/page.mdx Introduced a new documentation page guiding teams on accessing dedicated support channels.
packages/service-utils/src/core/usage.ts Added JSDoc deprecation annotations to usageEventSchema and UsageEvent, recommending use of UsageV2Event.

Sequence Diagram(s)

sequenceDiagram
    participant User
    participant PortalApp
    participant DocsPage

    User->>PortalApp: Navigate to Account > Teams
    PortalApp->>User: Display sidebar with "Get Dedicated Support" link
    User->>PortalApp: Click "Get Dedicated Support"
    PortalApp->>DocsPage: Render dedicated support documentation
    DocsPage->>User: Show instructions for creating and managing support channel
Loading

Possibly related PRs

  • thirdweb-dev/js#7381: Adds backend API and dashboard UI for creating and managing dedicated support channels, complementing the documentation and navigation in this PR.
  • thirdweb-dev/js#7382: Adds a dedicatedSupportChannel field to the TeamResponse type, directly supporting the dedicated support feature documented here.

Suggested reviewers

  • joaquim-verges
✨ 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.

@github-actions github-actions bot added Portal Involves changes to the Portal (docs) codebase. packages labels Jun 21, 2025
Copy link
Contributor Author


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.

This stack of pull requests is managed by Graphite. Learn more about stacking.

@arcoraven arcoraven marked this pull request as ready for review June 21, 2025 03:09
@arcoraven arcoraven requested review from a team as code owners June 21, 2025 03:09
Copy link

codecov bot commented Jun 21, 2025

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 52.06%. Comparing base (ff6e245) to head (ad0c8e6).
Report is 1 commits behind head on main.

Additional details and impacted files
@@           Coverage Diff           @@
##             main    #7399   +/-   ##
=======================================
  Coverage   52.06%   52.06%           
=======================================
  Files         945      945           
  Lines       63565    63565           
  Branches     4208     4208           
=======================================
  Hits        33098    33098           
  Misses      30361    30361           
  Partials      106      106           
Flag Coverage Δ
packages 52.06% <ø> (ø)
🚀 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

@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

🧹 Nitpick comments (1)
apps/portal/src/app/account/teams/get-dedicated-support/page.mdx (1)

1-1: Remove unused import
DocImage is imported but never used in this MDX page. Removing it will clean up unused code.

📜 Review details

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

📥 Commits

Reviewing files that changed from the base of the PR and between ff6e245 and ad0c8e6.

📒 Files selected for processing (4)
  • apps/portal/src/app/account/page.mdx (1 hunks)
  • apps/portal/src/app/account/sidebar.tsx (1 hunks)
  • apps/portal/src/app/account/teams/get-dedicated-support/page.mdx (1 hunks)
  • packages/service-utils/src/core/usage.ts (2 hunks)
⏰ Context from checks skipped due to timeout of 90000ms (3)
  • GitHub Check: Size
  • GitHub Check: Lint Packages
  • GitHub Check: Analyze (javascript)
🔇 Additional comments (3)
apps/portal/src/app/account/sidebar.tsx (1)

34-37: Add "Get Dedicated Support" link
The new sidebar item under the "Teams" section correctly points to /account/teams/get-dedicated-support and uses consistent naming.

packages/service-utils/src/core/usage.ts (1)

3-4: Mark usageEventSchema and UsageEvent as deprecated
The JSDoc @deprecated annotations above both the schema and the inferred type correctly signal the transition to UsageV2Event.

Also applies to: 85-86

apps/portal/src/app/account/page.mdx (1)

10-11: Update Teams navigation
Removed the "Manage Billing" entry and added "Get Dedicated Support" under the "Teams" section. The link text and path align with the new documentation page.

Copy link
Contributor

size-limit report 📦

Path Size Loading time (3g) Running time (snapdragon) Total time
thirdweb (esm) 62.56 KB (0%) 1.3 s (0%) 357 ms (+188.86% 🔺) 1.7 s
thirdweb (cjs) 350.74 KB (0%) 7.1 s (0%) 1.1 s (+22.03% 🔺) 8.1 s
thirdweb (minimal + tree-shaking) 5.72 KB (0%) 115 ms (0%) 133 ms (+1159.91% 🔺) 248 ms
thirdweb/chains (tree-shaking) 530 B (0%) 11 ms (0%) 107 ms (+3843.55% 🔺) 118 ms
thirdweb/react (minimal + tree-shaking) 19.61 KB (0%) 393 ms (0%) 171 ms (+829.78% 🔺) 563 ms

@arcoraven arcoraven merged commit 6fd630a into main Jun 21, 2025
26 of 27 checks passed
@arcoraven arcoraven deleted the ph/06-21-docs_add_docs_about_dedicated_support_channel branch June 21, 2025 04:13
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
packages Portal Involves changes to the Portal (docs) codebase.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

1 participant