-
Notifications
You must be signed in to change notification settings - Fork 130
chore: create branch for v3 website changes on v2 #3304
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
base: 10-25-chore_website_flatten_actors_docs_structure
Are you sure you want to change the base?
chore: create branch for v3 website changes on v2 #3304
Conversation
|
The latest updates on your projects. Learn more about Vercel for GitHub.
3 Skipped Deployments
|
|
Warning This pull request is not mergeable via GitHub because a downstack PR is open. Once all requirements are satisfied, merge this PR as a stack on Graphite.
How to use the Graphite Merge QueueAdd the label merge-queue to this PR to add it to 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. |
PR Review: Website V3 ChangesOverviewThis PR introduces significant marketing website improvements including a new Quickstart tab, redesigned deployment options, a features bento box component, and updated copy throughout. Overall, this is a solid update with good UX improvements. However, there are several issues that should be addressed. Critical Issues1. Unused Import in FeaturesBentoBox.tsxLocation: website/src/app/(v2)/(marketing)/(index)/sections/FeaturesBentoBox.tsx:13 The faCheckCircle import is never used in the component. Please remove the unused import. 2. Overly Broad Type for Icon PropLocation: website/src/app/(v2)/(marketing)/(index)/sections/FeaturesBentoBox.tsx:21 The icon prop uses any type, which defeats TypeScript type safety. Use a proper type from the icon library instead of any. 3. Unused Variant in TypeScript UnionLocation: website/src/app/(v2)/(marketing)/(index)/sections/FeaturesBentoBox.tsx:22 The variant type includes wide but there is no corresponding implementation for this variant. Either remove wide from the type definition, or add the implementation. 4. Misleading Link TextLocation: website/src/app/(v2)/(marketing)/(index)/sections/DeploymentOptionsSection.tsx:55 The link text says Contact Sales but it points to /docs/general/self-hosting, not a sales contact page. Either update the link to point to an actual sales contact page or change the text to match the destination. Code Quality Issues5. Inconsistent Tab/Space IndentationLocation: website/src/app/(v2)/(marketing)/(index)/components/MarketingButton.tsx:20-21 Mixed tabs and spaces in the indentation for target and rel props. Ensure consistent formatting across the file. 6. Unused Code VariantLocation: website/src/app/(v2)/(marketing)/(index)/sections/FeaturesBentoBox.tsx:131-154 The code variant is fully implemented but never used in the features array. Either remove it or add a feature that uses it. 7. Hardcoded Code ExampleThe code example in the code variant is hardcoded with manual syntax highlighting. Consider using a proper syntax highlighting library or accepting the code as a prop. Performance Considerations8. Mouse Move Event Listener EfficiencyLocation: website/src/app/(v2)/(marketing)/(index)/sections/FeaturesBentoBox.tsx:35-48 The handleMouseMove function performs querySelector on every mouse move event. Mouse move events fire frequently, so this could impact performance. Consider using a ref for the icon container instead of querySelector. Accessibility Issues9. Missing Icon Accessibility LabelsThe Icon components do not appear to have accessibility labels. Ensure icons are either decorative (with aria-hidden) or have proper labels. UX/Content Issues10. Removed Descriptive TextThe description paragraph was removed from the Run It Your Way section. Was this intentional? It provided helpful context for users. 11. Deleted Cloud Marketing PageThe entire cloud marketing page was removed. Ensure any inbound links to /cloud are redirected and SEO implications are considered. Positive Observations
SummaryThis is good work overall with solid UI/UX improvements. The main concerns are type safety, unused code, and the misleading Contact Sales link. Once these issues are addressed, this should be ready to merge. Recommendation: Request changes to address critical issues 1-4. |
- Added new Quickstart tab next to Overview and Integrations in docs navigation - Created new quickstart page at /docs/quickstart/ - Removed quickstart section from Overview tab sidebar - Updated all 'Get Started' buttons on home page to point to /docs/quickstart/ - Updated Local Development quickstart arrow to point to /docs/quickstart/ - Added quickstart to mobile navigation dropdown
3ac1277 to
8c067ef
Compare
PR Review: Website Changes v3OverviewThis PR introduces several improvements to the marketing website, including a new Quickstart navigation tab, updated hero messaging, a new features bento box component, and reorganized deployment options. The changes are primarily focused on improving the user experience and better communicating Rivet's value proposition. Positive Aspects✅ Good UX improvements: The new dedicated Quickstart tab is a smart addition that makes it easier for new users to get started quickly. ✅ Cleaner messaging: Updated hero section text ("The Primitive for Real-Time and Agent Applications") is more concise and clear about Rivet's purpose. ✅ Visual improvements: The new FeaturesBentoBox component provides a modern, interactive way to showcase features with nice hover effects. ✅ Consistent styling: Font sizes have been normalized across sections (4xl/5xl → 2xl/3xl) for better visual hierarchy. Issues & Recommendations1. Unused Import (FeaturesBentoBox.tsx:13)import { faCheckCircle } from "@rivet-gg/icons";Issue: Recommendation: Remove the unused import to keep the code clean. 2. Type Safety Issue (FeaturesBentoBox.tsx:21)icon: any;Issue: Using Recommendation: Use a more specific type. Based on the imports, this should be: import type { IconDefinition } from '@fortawesome/fontawesome-svg-core';
// or
icon: typeof faBolt; // or the appropriate FontAwesome icon type3. Duplicate Icons in Features Array (FeaturesBentoBox.tsx:191, 205)Issue: Both "Long-Lived Stateful Compute" and "Built-in Realtime" use Recommendation: Use distinct icons for different features. Consider 4. Unused Variant in Interface (FeaturesBentoBox.tsx:22)Issue: The Recommendation: Either implement the 5. Missing rel Attribute Usage (MarketingButton.tsx)Issue: While the Recommendation: If this is intended for external links, ensure it's used with <MarketingButton
href="https://external-site.com"
target="_blank"
rel="noopener noreferrer"
>6. Accessibility Concern (FeaturesBentoBox.tsx)Issue: The interactive cards use mouse position for spotlight effects but may not provide adequate feedback for keyboard navigation or screen readers. Recommendation: Consider adding:
7. Code Duplication in FeatureCard VariantsIssue: There's significant code duplication across the different variant implementations (large, medium, small, default). The hover overlay and structure are repeated. Recommendation: Extract common elements into reusable components or variables: const HoverOverlay = () => (
<div className="absolute inset-0 opacity-0 group-hover:opacity-100 transition-opacity duration-300 pointer-events-none bg-gradient-to-b from-white/[0.04] via-white/[0.01] to-transparent" />
);8. Inconsistent Link Behavior (DeploymentOptionsSection.tsx)Issue: Some links use Recommendation: Establish consistent patterns:
9. Hardcoded Code Example (FeaturesBentoBox.tsx:131-154)Issue: The "code" variant contains a hardcoded, complex JSX structure with syntax highlighting. This makes it difficult to reuse and maintain. Recommendation:
10. Missing Error Handling (FeatureCard.tsx:35-47)Issue: The Recommendation: While the early return is good, consider logging errors in development for debugging. Testing Recommendations
Security Considerations
DocumentationThe new quickstart page at
Performance ConsiderationsThe
SummaryOverall, this is a solid PR that improves the user experience and modernizes the website. The main concerns are:
Recommendation: Address the type safety and accessibility concerns before merging. The code duplication and other issues can be addressed in follow-up PRs if needed. Checklist Before Merge
Let me know if you'd like me to help implement any of these suggestions! |

chore: create branch for v3 website changes on v2
chore(site): website changes v3
Add Quickstart tab to docs page and update all Get Started links