chore: update team/account docs for team management #7341
Conversation
|
The latest updates on your projects. Learn more about Vercel for Git ↗︎
|
|
|
Caution Review failedThe pull request is closed. """ WalkthroughThe changes reorganize the account-related documentation and sidebar navigation in the portal application. The account section is now titled "Teams & Accounts," with content and navigation split into new subsections for accounts, teams, projects, and FAQs. Two new documentation pages, "Manage Teams" and "Manage Team Members," were introduced. Changes
Sequence Diagram(s)sequenceDiagram
User->>Portal Sidebar: Navigate to "Teams & Accounts"
Portal Sidebar->>User: Show nested sections (Account, Teams, Projects, FAQs)
User->>Teams Section: Select "Manage Teams" or "Manage Team Members"
Teams Section->>Documentation Page: Display relevant instructions and UI
Possibly related PRs
📜 Recent review detailsConfiguration used: CodeRabbit UI ⛔ Files ignored due to path filters (1)
📒 Files selected for processing (5)
✨ 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 (
|
github-actions
bot
added
the
Portal
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. This stack of pull requests is managed by Graphite. Learn more about stacking. |
Codecov ReportAll modified and coverable lines are covered by tests ✅
Additional details and impacted files@@ Coverage Diff @@
## main #7341 +/- ##
=======================================
Coverage 55.58% 55.58%
=======================================
Files 909 909
Lines 58683 58683
Branches 4158 4158
=======================================
Hits 32617 32617
Misses 25959 25959
Partials 107 107
🚀 New features to boost your workflow:
|
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
There was a problem hiding this comment.
Actionable comments posted: 1
🧹 Nitpick comments (3)
apps/portal/src/app/account/page.mdx (1)
20-21: Minor duplication – heading + bullet are identical.Having “## FAQs” immediately followed by “- FAQs” is a bit redundant.
Consider either renaming the bullet (e.g. “Common questions”) or dropping it and linking the heading directly.🧰 Tools
🪛 LanguageTool
[duplication] ~20-~20: Possible typo: you repeated a word.
Context: ...account/api-keys/transfer-projects) ## FAQs - FAQs(ENGLISH_WORD_REPEAT_RULE)
apps/portal/src/app/account/teams/manage-team-members/page.mdx (2)
15-16: Typo: “Setting” → “Settings”.-<Step title="Navigate to Setting > Members"> +<Step title="Navigate to Settings > Members">
22-23: Role naming consistency.Earlier you capitalise roles (“Member”, “Owner”).
Consider matching that here: “…assign a Member or Owner role.”
📜 Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro
⛔ Files ignored due to path filters (1)
apps/portal/src/app/account/teams/assets/manage-team.pngis excluded by!**/*.png
📒 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/manage-team-members/page.mdx(1 hunks)apps/portal/src/app/account/teams/manage-teams/page.mdx(1 hunks)
🧰 Additional context used
🪛 LanguageTool
apps/portal/src/app/account/page.mdx
[grammar] ~7-~7: This phrase is duplicated. You should probably use “Teams Manage” only once.
Context: ...k Accounts](/account/link-accounts) ## Teams - Manage Teams - [Manage Team Members](/account/teams/manage-tea...
(PHRASE_REPETITION)
[duplication] ~20-~20: Possible typo: you repeated a word.
Context: ...account/api-keys/transfer-projects) ## FAQs - FAQs
(ENGLISH_WORD_REPEAT_RULE)
⏰ Context from checks skipped due to timeout of 90000ms (8)
- GitHub Check: Lint Packages
- GitHub Check: E2E Tests (pnpm, esbuild)
- GitHub Check: E2E Tests (pnpm, webpack)
- GitHub Check: E2E Tests (pnpm, vite)
- GitHub Check: Size
- GitHub Check: Unit Tests
- GitHub Check: Build Packages
- GitHub Check: Analyze (javascript)
🔇 Additional comments (3)
apps/portal/src/app/account/page.mdx (1)
11-18:✅ Verification successful
Slug/path still references “api-keys” although the UI now calls it “Projects.”
All links under the new Projects heading still point to
/account/api-keys/....
If the route has also been renamed to/account/projects, these links will 404.If the route was renamed, update the doc (and sidebar) accordingly.
🏁 Script executed:
#!/bin/bash # Verify whether `/account/api-keys` is still the canonical route rg --heading --line-number "/account/api-keys" | head -n 20Length of output: 951
No changes needed—routes remain
/account/api-keysI’ve confirmed that
/account/api-keysis still the canonical route (see redirects, header, engine pages, etc.), so the “Projects” heading simply reflects a UI label change and all links will continue to resolve correctly.apps/portal/src/app/account/teams/manage-teams/page.mdx (1)
30-38: Clear, actionable steps – looks good.The transfer-ownership flow is concise and matches the UI. No issues spotted.
apps/portal/src/app/account/sidebar.tsx (1)
5-19: Renaming & regrouping look correct.The new top-level label and nested Account group align with the MDX changes. 👍
| { | ||
| name: "Teams", | ||
| links: [ | ||
| { | ||
| name: "Upgrade Plan", | ||
| href: `${accountSlug}/billing/upgrade-plan`, | ||
| name: "Manage Teams", | ||
| href: `${accountSlug}/teams/manage-teams`, | ||
| }, | ||
| { | ||
| name: "Manage Team", | ||
| href: `${accountSlug}/billing/manage-team`, | ||
| name: "Manage Team Members", | ||
| href: `${accountSlug}/teams/manage-team-members`, | ||
| }, | ||
| ], | ||
| }, |
There was a problem hiding this comment.
💡 Verification agent
🧩 Analysis chain
Verify that no orphaned “Billing” links remain elsewhere.
We dropped the Billing section here; ensure there are no stale links in other docs/components.
🏁 Script executed:
#!/bin/bash
# Search for leftover /account/billing routes
rg --heading --line-number "/account/billing" || trueLength of output: 727
Remove Remaining “Billing” Links
We’ve removed the Billing section from the account sidebar, but there are still hard-coded references elsewhere. Please update or remove these stale links:
- apps/portal/src/app/account/faq/page.mdx: line 73
[Manage Billing](/account/billing/manage-billing) - apps/dashboard/src/app/(app)/team/[team_slug]/(team)/~/settings/billing/components/PlanInfoCard.tsx: line 218
href="https://portal.thirdweb.com/account/billing/manage-billing" - apps/dashboard/src/app/(app)/login/onboarding/LinkWalletPrompt/LinkWalletPrompt.tsx: line 76
href="https://portal.thirdweb.com/account/billing/account-info"
🤖 Prompt for AI Agents
In apps/portal/src/app/account/sidebar.tsx lines 20 to 32, the Billing section
was removed from the sidebar, but there are still hard-coded Billing links
elsewhere in the codebase. Locate and update or remove these stale Billing links
in the specified files: apps/portal/src/app/account/faq/page.mdx at line 73,
apps/dashboard/src/app/(app)/team/[team_slug]/(team)/~/settings/billing/components/PlanInfoCard.tsx
at line 218, and
apps/dashboard/src/app/(app)/login/onboarding/LinkWalletPrompt/LinkWalletPrompt.tsx
at line 76. Ensure these links no longer reference the removed Billing routes or
update them to valid paths.
size-limit report 📦
|
arcoraven
force-pushed
the
ph/06-14-chore_update_team_account_docs_for_team_management
branch
from
ef1f1c7 to
d2c587a
Compare
Merge activity
|
arcoraven
deleted the
ph/06-14-chore_update_team_account_docs_for_team_management
branch
[Portal] Feature: Reorganize Teams & Accounts section
Notes for the reviewer
This PR reorganizes the account section into a more structured "Teams & Accounts" section with clearer navigation. The changes include:
How to test
Navigate through the account section to verify all links work correctly and the new team management pages display properly.
Summary by CodeRabbit
New Features
Documentation
PR-Codex overview
This PR focuses on enhancing the documentation for managing teams and accounts within the application. It introduces new content for inviting team members, managing teams, and updating sidebar links to reflect these changes.
Detailed summary
page.mdxandmanage-team.pngfiles.manage-team-members/page.mdx.sidebar.tsxto reflect "Teams & Accounts" and related links.manage-teams/page.mdx.page.mdxto include new team management options.