Update vault documentation text and faq #8367
Conversation
|
Cursor Agent can help with this pull request. Just |
|
|
The latest updates on your projects. Learn more about Vercel for GitHub.
4 Skipped Deployments
|
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. |
github-actions
bot
added
the
Portal
WalkthroughThree Vault pages were edited: metadata and introduction text were reworded to remove "open-source" references and clarify Vault's status and architecture; a new FAQ entry was added stating "Vault is not yet open source, but we plan to release it soon." Changes
Estimated code review effort🎯 2 (Simple) | ⏱️ ~8 minutes
Pre-merge checks and finishing touches✅ Passed checks (3 passed)
✨ Finishing touches
🧪 Generate unit tests (beta)
📜 Recent review detailsConfiguration used: CodeRabbit UI Review profile: CHILL Plan: Pro Disabled knowledge base sources:
📒 Files selected for processing (3)
🚧 Files skipped from review as they are similar to previous changes (2)
⏰ 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). (6)
🔇 Additional comments (1)
Comment |
Codecov Report✅ All modified and coverable lines are covered by tests. Additional details and impacted files@@ Coverage Diff @@
## main #8367 +/- ##
=======================================
Coverage 54.64% 54.64%
=======================================
Files 919 919
Lines 60693 60693
Branches 4111 4111
=======================================
Hits 33167 33167
Misses 27424 27424
Partials 102 102
🚀 New features to boost your workflow:
|
size-limit report 📦
|
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
There was a problem hiding this comment.
Actionable comments posted: 0
🧹 Nitpick comments (1)
apps/portal/src/app/vault/layout.tsx (1)
5-11: Add explicit return type annotation to async function.Per coding guidelines, async functions should have explicit return type annotations. The function currently lacks a return type.
Apply this diff to add the explicit return type:
-export default async function Layout(props: { children: React.ReactNode }) { +export default async function Layout(props: { children: React.ReactNode }): Promise<React.ReactElement> { return ( <DocLayout editPageButton={true} sideBar={sidebar}> {props.children} </DocLayout> ); }
📜 Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro
Disabled knowledge base sources:
- Linear integration is disabled by default for public repositories
You can enable these sources in your CodeRabbit configuration.
📒 Files selected for processing (3)
apps/portal/src/app/vault/faqs/page.mdx(1 hunks)apps/portal/src/app/vault/layout.tsx(1 hunks)apps/portal/src/app/vault/page.mdx(2 hunks)
🧰 Additional context used
📓 Path-based instructions (2)
**/*.{ts,tsx}
📄 CodeRabbit inference engine (CLAUDE.md)
**/*.{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@/typesor localtypes.tsbarrels
Prefer type aliases over interface except for nominal shapes
Avoidanyandunknownunless unavoidable; narrow generics when possible
Choose composition over inheritance; leverage utility types (Partial,Pick, etc.)
Comment only ambiguous logic; avoid restating TypeScript in prose
**/*.{ts,tsx}: Use explicit function declarations and explicit return types in TypeScript
Limit each file to one stateless, single‑responsibility function
Re‑use shared types from@/typeswhere applicable
Prefertypealiases overinterfaceexcept for nominal shapes
Avoidanyandunknownunless unavoidable; narrow generics when possible
Prefer composition over inheritance; use utility types (Partial, Pick, etc.)
Lazy‑import optional features and avoid top‑level side‑effects to reduce bundle size
Files:
apps/portal/src/app/vault/layout.tsx
**/*.{ts,tsx,js,jsx}
📄 CodeRabbit inference engine (CLAUDE.md)
Load heavy dependencies inside async paths to keep initial bundle lean (lazy loading)
Files:
apps/portal/src/app/vault/layout.tsx
🧠 Learnings (1)
📚 Learning: 2025-07-18T19:19:55.613Z
Learnt from: CR
Repo: thirdweb-dev/js PR: 0
File: CLAUDE.md:0-0
Timestamp: 2025-07-18T19:19:55.613Z
Learning: Surface breaking changes prominently in PR descriptions
Applied to files:
apps/portal/src/app/vault/page.mdx
🔇 Additional comments (3)
apps/portal/src/app/vault/faqs/page.mdx (1)
47-49: Clear and well-placed FAQ clarification.The new entry effectively addresses the open-source status question and aligns with messaging across the documentation. The Details component usage is consistent with existing FAQ items.
apps/portal/src/app/vault/layout.tsx (1)
13-21: Metadata description clearly reflects Vault's current positioning.The updated description removes "open-source" and provides an accurate, concise overview of Vault's core capabilities and architecture. Consistent with changes across the vault documentation.
apps/portal/src/app/vault/page.mdx (1)
8-8: Updated descriptions clearly position Vault's non-custodial architecture.Both the metadata description (line 8) and introduction paragraph (line 17) now provide a clearer, more neutral characterization of Vault without the "open-source" terminology. The messaging aligns well with layout.tsx and is consistent across the documentation.
Also applies to: 17-17
Merge activity
|
``` [Portal] Fix: Update Vault open-source status and add FAQ ## Notes for the reviewer This PR updates the Vault portal documentation to accurately reflect its open-source status. * Removed "open-source" from the main description and metadata on the Vault overview page. * Added a new FAQ entry under `/vault/faqs` clarifying that Vault is not yet open source. ## How to test 1. Navigate to <https://portal.thirdweb.com/vault> * Verify the main description no longer includes "open-source". * (Optional) Inspect page metadata to confirm "open-source" is removed from the description. 2. Navigate to <https://portal.thirdweb.com/vault/faqs> * Verify the new FAQ "Is Vault open source?" is present with the answer "Vault is not yet open source, but we plan to release it soon." ``` --- [Slack Thread](https://thirdwebdev.slack.com/archives/C09DS2CKGP2/p1762411784588169?thread_ts=1762411784.588169&cid=C09DS2CKGP2) <a href="https://cursor.com/background-agent?bcId=bc-ab8c2b24-6a74-4e0c-b302-d84d69ac5953"><picture><source media="(prefers-color-scheme: dark)" srcset="https://cursor.com/open-in-cursor-dark.svg"><source media="(prefers-color-scheme: light)" srcset="https://cursor.com/open-in-cursor-light.svg"><img alt="Open in Cursor" src="https://cursor.com/open-in-cursor.svg"></picture></a> <a href="https://cursor.com/agents?id=bc-ab8c2b24-6a74-4e0c-b302-d84d69ac5953"><picture><source media="(prefers-color-scheme: dark)" srcset="https://cursor.com/open-in-web-dark.svg"><source media="(prefers-color-scheme: light)" srcset="https://cursor.com/open-in-web-light.svg"><img alt="Open in Web" src="https://cursor.com/open-in-web.svg"></picture></a> <!-- start pr-codex --> --- ## PR-Codex overview This PR focuses on updating the description of the `Vault` service to remove references to it being open source and refining the language for clarity. ### Detailed summary - Added a new `Details` section in `apps/portal/src/app/vault/faqs/page.mdx` about Vault's open-source status. - Updated the `description` in `apps/portal/src/app/vault/layout.tsx` to remove "open-source." - Revised the `description` in `apps/portal/src/app/vault/page.mdx` to remove "open-source." - Modified the main description of `Vault` in `apps/portal/src/app/vault/page.mdx` for clarity. > ✨ 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 ## Documentation * Added new FAQ entry addressing open-source availability with information on future release plans * Updated Vault service descriptions emphasizing non-custodial key management design and TEE security architecture * Refined documentation metadata to provide clearer communication of Vault's core features, security model, and service capabilities <!-- end of auto-generated comment: release notes by coderabbit.ai -->
graphite-app
bot
force-pushed
the
cursor/update-vault-documentation-text-and-faq-4abe
branch
from
9688a55 to
f0edc0f
Compare
graphite-app
bot
deleted the
cursor/update-vault-documentation-text-and-faq-4abe
branch
graphite-app
bot
removed
the
merge-queue
![https://cursor.com/open-in-cursor-dark.svg"><source](https://cursor.com/open-in-cursor-dark.svg"><source){kind=link}
![https://cursor.com/open-in-cursor-light.svg"><img](https://cursor.com/open-in-cursor-light.svg"><img){kind=link}
![https://cursor.com/open-in-cursor.svg"></picture></a> <a](https://cursor.com/open-in-cursor.svg"></picture></a> <a){kind=link}
![https://cursor.com/open-in-web-dark.svg"><source](https://cursor.com/open-in-web-dark.svg"><source){kind=link}
![https://cursor.com/open-in-web-light.svg"><img](https://cursor.com/open-in-web-light.svg"><img){kind=link}
![https://cursor.com/open-in-web.svg"></picture></a](https://cursor.com/open-in-web.svg"></picture></a){kind=link}
Slack Thread
PR-Codex overview
This PR focuses on updating the descriptions related to
Vaultto remove references to it being open source and to clarify its nature as a non-custodial key management service.Detailed summary
page.mdxabout whetherVaultis open source.descriptioninlayout.tsxto remove "open-source".descriptioninpage.mdxto remove "open-source".page.mdxto remove "open-source".Summary by CodeRabbit