[Docs] Improvements to acct, ec, and vault docs #7246
Conversation
|
|
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. |
## Walkthrough
This update reorganizes navigation links in the portal header, adds and updates documentation across several sections, introduces a new page on smart server wallets, revises multiple FAQs, and enhances migration and troubleshooting guidance. It also adds new security-related FAQs for vaults and removes outdated Nebula FAQ entries.
## Changes
| File(s) | Change Summary |
|------------------------------------------------------------------------------------------|------------------------------------------------------------------------------------------------------------------|
| apps/portal/src/app/Header.tsx | Moved "Account" link from toolLinks to supportLinks, removed "Contact Sales," and added "Status" link. |
| apps/portal/src/app/account/billing/manage-team/page.mdx | Added "Transfer Ownership" section with step-by-step instructions. |
| apps/portal/src/app/account/faq/page.mdx | Updated billing FAQ to reference customized/enterprise plans and simplified answer. |
| apps/portal/src/app/engine/v3/configure-wallets/smart-server-wallet/server-wallets/page.mdx | Added new documentation page for Smart Server Wallets. |
| apps/portal/src/app/engine/v3/faq/page.mdx | Updated pricing FAQ to reference pricing page and added new supported chains FAQ. |
| apps/portal/src/app/engine/v3/troubleshoot/page.mdx | Replaced placeholder with troubleshooting instructions and added Details import. |
| apps/portal/src/app/nebula/faqs/page.mdx | Removed FAQ entries about access approval and pricing availability. |
| apps/portal/src/app/typescript/v5/migrate/page.mdx | Added deprecation warning callout for TypeScript SDK v4. |
| apps/portal/src/app/vault/faqs/page.mdx | Added FAQs on key requirements for server wallets and admin key handling in the dashboard. |
## Sequence Diagram(s)
```mermaid
sequenceDiagram
participant User
participant PortalHeader
participant SupportLinks
User->>PortalHeader: Loads portal
PortalHeader->>SupportLinks: Render links
SupportLinks-->>User: Show "Account" and "Status" under SupportsequenceDiagram
participant Owner
participant Portal
participant SettingsPage
Owner->>Portal: Login
Owner->>SettingsPage: Navigate to Members
Owner->>SettingsPage: Invite new owner, assign "Owner" role
Owner->>SettingsPage: Remove previous owner
Suggested reviewers
|
github-actions
bot
added
the
Portal
Codecov ReportAll modified and coverable lines are covered by tests ✅
Additional details and impacted files@@ Coverage Diff @@
## main #7246 +/- ##
=======================================
Coverage 55.55% 55.55%
=======================================
Files 908 908
Lines 58571 58571
Branches 4131 4131
=======================================
Hits 32540 32540
Misses 25927 25927
Partials 104 104
🚀 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: 2
🧹 Nitpick comments (4)
apps/portal/src/app/typescript/v5/migrate/page.mdx (1)
11-13: Grammar refinement for clarity in warning callout
Consider tightening the phrasing to sound more natural in documentation. For example:
- Change “We highly recommend you to migrate to the latest version of the SDK v5 as soon as possible.”
- To: “We strongly recommend migrating to SDK v5 as soon as possible.”
This removes the infinitive “to migrate” construction and makes the recommendation more direct.
apps/portal/src/app/engine/v3/faq/page.mdx (2)
6-6: Replace explicit cost with pricing page link
The update correctly removes the hard-coded cost and links to the thirdweb pricing page. Consider tweaking the grammar in “For requests costs” to “For request costs” for clarity.
15-19: Add hyperlink to supported chains list
Great addition of the “Which chains does Engine Cloud support?” FAQ. I recommend turning “See the current list of supported chains.” into an actual link to the maintained chains page so users can jump directly to it.apps/portal/src/app/vault/faqs/page.mdx (1)
37-45: Add missing article and vary sentence openings
In “The admin key is temporarily stored in dashboard…”, add “the” before “dashboard.” Also consider rephrasing the repeated “It is only…” sentences to avoid redundancy.🧰 Tools
🪛 LanguageTool
[style] ~42-~42: Three successive sentences begin with the same word. Consider rewording the sentence or use a thesaurus to find a synonym.
Context: ...ommunication with Vault is happening. - It is not persisted or stored after your s...(ENGLISH_WORD_REPEAT_BEGINNING_RULE)
📜 Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro
📒 Files selected for processing (9)
apps/portal/src/app/Header.tsx(1 hunks)apps/portal/src/app/account/billing/manage-team/page.mdx(1 hunks)apps/portal/src/app/account/faq/page.mdx(1 hunks)apps/portal/src/app/engine/v3/configure-wallets/smart-server-wallet/server-wallets/page.mdx(1 hunks)apps/portal/src/app/engine/v3/faq/page.mdx(1 hunks)apps/portal/src/app/engine/v3/troubleshoot/page.mdx(1 hunks)apps/portal/src/app/nebula/faqs/page.mdx(0 hunks)apps/portal/src/app/typescript/v5/migrate/page.mdx(1 hunks)apps/portal/src/app/vault/faqs/page.mdx(1 hunks)
💤 Files with no reviewable changes (1)
- apps/portal/src/app/nebula/faqs/page.mdx
🧰 Additional context used
🪛 LanguageTool
apps/portal/src/app/engine/v3/configure-wallets/smart-server-wallet/server-wallets/page.mdx
[uncategorized] ~7-~7: Possible missing article found.
Context: ...y to perform blockchain operations with Engine. - Managed Gas Fees: Smart server ...
(AI_HYDRA_LEO_MISSING_THE)
[misspelling] ~13-~13: This word is normally spelled as one.
Context: ...s can handle higher throughput by using multi-dimensional nonces. While Engine handles concurrent...
(EN_COMPOUNDS_MULTI_DIMENSIONAL)
apps/portal/src/app/vault/faqs/page.mdx
[style] ~42-~42: Three successive sentences begin with the same word. Consider rewording the sentence or use a thesaurus to find a synonym.
Context: ...ommunication with Vault is happening. - It is not persisted or stored after your s...
(ENGLISH_WORD_REPEAT_BEGINNING_RULE)
⏰ Context from checks skipped due to timeout of 90000ms (8)
- GitHub Check: Size
- GitHub Check: E2E Tests (pnpm, esbuild)
- GitHub Check: E2E Tests (pnpm, webpack)
- GitHub Check: Build Packages
- GitHub Check: E2E Tests (pnpm, vite)
- GitHub Check: Lint Packages
- GitHub Check: Unit Tests
- GitHub Check: Analyze (javascript)
🔇 Additional comments (8)
apps/portal/src/app/typescript/v5/migrate/page.mdx (1)
3-4: Approve import ofCalloutcomponent
The addition of theCalloutimport from@docaligns with existing patterns for alerting users in MDX pages. Ensure that this import does not conflict with other modules named@docand that your bundler/resolver picks up the correct package.apps/portal/src/app/Header.tsx (1)
187-193: LGTM! Good navigation reorganization.The changes improve the logical grouping of navigation links by:
- Moving "Account" to support links where it belongs conceptually
- Adding a "Status" link for operational transparency
- Following the established pattern for external links
This enhances user experience by providing clearer categorization of support-related resources.
apps/portal/src/app/account/faq/page.mdx (1)
68-69: LGTM! More accurate and inclusive FAQ update.The changes improve the FAQ by:
- Broadening the scope from "Pro plan" to "customized or enterprise" plans, making it more inclusive
- Simplifying the answer to appropriately direct users to Sales for complex pricing discussions
- Aligning with the navigation changes that moved Sales contact to account-specific contexts
This provides clearer guidance for users seeking enterprise-level solutions.
apps/portal/src/app/account/billing/manage-team/page.mdx (1)
33-49: LGTM! Excellent addition of transfer ownership documentation.The new section provides valuable functionality documentation with:
- Proper closure of the previous Steps component
- Clear three-step process for ownership transfer
- Important guidance about ensuring invitation acceptance before removing the prior owner
- Consistent formatting with the existing documentation structure
This addresses a common administrative need and enhances the team management documentation.
apps/portal/src/app/engine/v3/troubleshoot/page.mdx (1)
1-10: LGTM! Great improvement replacing placeholder with actionable content.The changes enhance the troubleshooting guide by:
- Adding the necessary Details component import
- Replacing placeholder text with specific, actionable troubleshooting steps
- Providing clear navigation instructions for enabling Account Abstraction
- Using the Details component appropriately for expandable content
This provides users with practical guidance for resolving pending transaction issues in Engine Cloud.
apps/portal/src/app/engine/v3/configure-wallets/smart-server-wallet/server-wallets/page.mdx (1)
23-25: Pricing section added correctly
The note on mainnet gas premium and testnet waivers is clear and concise. Linking to the pricing page maintains consistency with Engine FAQ.apps/portal/src/app/vault/faqs/page.mdx (2)
25-25: Clarify rotation code workflow
The new detail about requiring a wallet signature and exposing rotation history adds valuable transparency for users.
27-35: New server-wallet key FAQ looks good
This entry clearly explains the distinction between using an admin key vs. scoped access token.
apps/portal/src/app/engine/v3/configure-wallets/smart-server-wallet/server-wallets/page.mdx
Outdated
Show resolved
Hide resolved
apps/portal/src/app/engine/v3/configure-wallets/smart-server-wallet/server-wallets/page.mdx
Outdated
Show resolved
Hide resolved
There was a problem hiding this comment.
Actionable comments posted: 1
🧹 Nitpick comments (1)
apps/portal/src/app/engine/v3/configure-wallets/smart-server-wallet/server-wallets/page.mdx (1)
15-19: Grammar Improvement: Add Commas in Security Section
For clarity, enclose the nonrestrictive clause in commas. Suggested change:- Keys used to manage server wallets including the admin key and access keys can be rotated or re-rolled at any time, should you need to rotate keys for security purposes. + Keys used to manage server wallets, including the admin key and access keys, can be rotated or re-rolled at any time, should you need to rotate keys for security purposes.🧰 Tools
🪛 LanguageTool
[uncategorized] ~18-~18: Possible missing comma found.
Context: ...ed securely. Keys used to manage server wallets including the admin key and access keys...(AI_HYDRA_LEO_MISSING_COMMA)
📜 Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro
📒 Files selected for processing (1)
apps/portal/src/app/engine/v3/configure-wallets/smart-server-wallet/server-wallets/page.mdx(1 hunks)
🧰 Additional context used
🪛 LanguageTool
apps/portal/src/app/engine/v3/configure-wallets/smart-server-wallet/server-wallets/page.mdx
[uncategorized] ~7-~7: Possible missing article found.
Context: ...y to perform blockchain operations with Engine. - Managed Gas Fees: Smart server ...
(AI_HYDRA_LEO_MISSING_THE)
[misspelling] ~13-~13: This word is normally spelled as one.
Context: ...s can handle higher throughput by using multi-dimensional nonces. While Engine handles concurrent...
(EN_COMPOUNDS_MULTI_DIMENSIONAL)
[uncategorized] ~13-~13: Possible missing article found.
Context: ...y using multi-dimensional nonces. While Engine handles concurrent transactions through...
(AI_HYDRA_LEO_MISSING_THE)
[uncategorized] ~18-~18: Possible missing comma found.
Context: ...ed securely. Keys used to manage server wallets including the admin key and access keys...
(AI_HYDRA_LEO_MISSING_COMMA)
⏰ Context from checks skipped due to timeout of 90000ms (8)
- GitHub Check: E2E Tests (pnpm, esbuild)
- GitHub Check: Size
- GitHub Check: E2E Tests (pnpm, webpack)
- GitHub Check: Lint Packages
- GitHub Check: E2E Tests (pnpm, vite)
- GitHub Check: Build Packages
- GitHub Check: Unit Tests
- GitHub Check: Analyze (javascript)
🔇 Additional comments (3)
apps/portal/src/app/engine/v3/configure-wallets/smart-server-wallet/server-wallets/page.mdx (3)
1-2: Heading Check: H1 Title Follows Style
The main heading “Smart Server Wallets” is clear and uses consistent title-case formatting.
5-14: Benefits Section Clarity
The benefits section is well-structured and effectively highlights key advantages (managed gas fees, secure key management, minimal setup, higher throughput). No further edits required.🧰 Tools
🪛 LanguageTool
[uncategorized] ~7-~7: Possible missing article found.
Context: ...y to perform blockchain operations with Engine. - Managed Gas Fees: Smart server ...(AI_HYDRA_LEO_MISSING_THE)
[misspelling] ~13-~13: This word is normally spelled as one.
Context: ...s can handle higher throughput by using multi-dimensional nonces. While Engine handles concurrent...(EN_COMPOUNDS_MULTI_DIMENSIONAL)
[uncategorized] ~13-~13: Possible missing article found.
Context: ...y using multi-dimensional nonces. While Engine handles concurrent transactions through...(AI_HYDRA_LEO_MISSING_THE)
21-24: Pricing Link and Content
The pricing section clearly explains gas premium fees on mainnet and links to the pricing page. This aligns with existing doc conventions.
apps/portal/src/app/engine/v3/configure-wallets/smart-server-wallet/server-wallets/page.mdx
Outdated
Show resolved
Hide resolved
size-limit report 📦
|
There was a problem hiding this comment.
Actionable comments posted: 1
🧹 Nitpick comments (3)
apps/portal/src/app/engine/v3/configure-wallets/smart-server-wallet/server-wallets/page.mdx (3)
13-13: Standardize "multidimensional" hyphenation
Consider using "multidimensional nonces" without a hyphen for consistency and to align with common technical usage.- Smart server wallets can handle higher throughput by using multi-dimensional nonces. + Smart server wallets can handle higher throughput by using multidimensional nonces.🧰 Tools
🪛 LanguageTool
[misspelling] ~13-~13: This word is normally spelled as one.
Context: ...s can handle higher throughput by using multi-dimensional nonces. While Engine handles concurrent...(EN_COMPOUNDS_MULTI_DIMENSIONAL)
18-18: Clarify key rotation terminology
The term "re-rolled" may be confusing; consider using "rotated" to maintain consistency with key management language.- Keys used to manage server wallets including the admin key and access keys can be rotated or re-rolled at any time + Keys used to manage server wallets including the admin key and access keys can be rotated at any time
23-24: Enhance external link accessibility
For external links, open in a new tab and addrel="noopener noreferrer"to improve security and user experience.- [See pricing page for details](https://thirdweb.com/pricing). + <a href="https://thirdweb.com/pricing" target="_blank" rel="noopener noreferrer"> + See pricing page for details + </a>
📜 Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro
📒 Files selected for processing (1)
apps/portal/src/app/engine/v3/configure-wallets/smart-server-wallet/server-wallets/page.mdx(1 hunks)
🧰 Additional context used
🪛 LanguageTool
apps/portal/src/app/engine/v3/configure-wallets/smart-server-wallet/server-wallets/page.mdx
[misspelling] ~13-~13: This word is normally spelled as one.
Context: ...s can handle higher throughput by using multi-dimensional nonces. While Engine handles concurrent...
(EN_COMPOUNDS_MULTI_DIMENSIONAL)
⏰ Context from checks skipped due to timeout of 90000ms (8)
- GitHub Check: E2E Tests (pnpm, esbuild)
- GitHub Check: E2E Tests (pnpm, webpack)
- GitHub Check: Unit Tests
- GitHub Check: E2E Tests (pnpm, vite)
- GitHub Check: Lint Packages
- GitHub Check: Size
- GitHub Check: Build Packages
- GitHub Check: Analyze (javascript)
🔇 Additional comments (1)
apps/portal/src/app/engine/v3/configure-wallets/smart-server-wallet/server-wallets/page.mdx (1)
1-4: Well-structured introduction
The title and overview clearly explain what Smart Server Wallets are. Nice and concise.
apps/portal/src/app/engine/v3/configure-wallets/smart-server-wallet/server-wallets/page.mdx
Show resolved
Hide resolved
saminacodes
added
the
merge-queue
Merge activity
|
CORE-0000
<!-- start pr-codex -->
---
## PR-Codex overview
This PR focuses on updating various documentation and component links within the `thirdweb` portal, as well as enhancing the content of FAQs and guides to provide clearer information on account management, migration to the TypeScript SDK v5, and Engine Cloud features.
### Detailed summary
- Added `Account` link to `supportLinks` in `Header.tsx`.
- Included warning about deprecation of TypeScript SDK v4 in `page.mdx`.
- Added troubleshooting details for transactions in `Engine Troubleshoot Guide`.
- Updated FAQ on customized plans in `faq/page.mdx`.
- Introduced ownership transfer steps in `manage-team/page.mdx`.
- Removed outdated Nebula access details in `faqs/page.mdx`.
- Added details about server wallet keys and admin key usage in `vault/faqs/page.mdx`.
- Updated pricing explanation and added a new chains support detail in `Engine Cloud` FAQ.
- Introduced a new section on `Smart Server Wallets`, detailing benefits and security in `server-wallets/page.mdx`.
> ✨ 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**
- Introduced a new documentation page for Smart Server Wallets, outlining features, security, and pricing.
- Added new FAQ entries to the Vault documentation regarding key requirements for server wallets and admin key handling.
- Added a new FAQ entry detailing supported chains for Engine Cloud.
- **Improvements**
- Updated navigation links in the header, moving "Account" to support links and adding a "Status" link.
- Enhanced troubleshooting guidance for Engine Cloud transactions.
- Updated Engine Cloud pricing FAQ to reference the pricing page.
- Added a warning callout about TypeScript SDK v4 deprecation to the migration guide.
- Expanded billing documentation with a new section on transferring team ownership.
- Clarified the FAQ about signing up for customized or enterprise plans.
- **Removals**
- Removed outdated Nebula FAQ entries related to access approval and pricing.
<!-- end of auto-generated comment: release notes by coderabbit.ai -->
graphite-app
bot
force-pushed
the
docs-bulk-updates
branch
from
94289d2 to
f1479b8
Compare
graphite-app
bot
removed
the
merge-queue
CORE-0000
PR-Codex overview
This PR focuses on updating the content across various documentation and component files in the
thirdwebportal, including the addition of new sections, rephrasing existing information, and removing outdated content.Detailed summary
Accountlink to the header.Calloutabout the deprecation of TypeScript SDK v4.Engine Cloud.Transfer Ownershipsteps in team management.Engine Cloudand added chain support information.Smart Server Walletssection detailing benefits, security, and pricing.Summary by CodeRabbit
New Features
Improvements
Removals