Change gifs on README.md#209
Conversation
|
The latest updates on your projects. Learn more about Vercel for GitHub.
|
WalkthroughREADME.md documentation corrected for grammar and formatting; BRAND_GUIDELINES.md file removed entirely; HeroSection component enhanced with "Manage Terminals" selector option plus associated background gradient and demo GIF constants. Changes
Estimated code review effort🎯 2 (Simple) | ⏱️ ~10 minutes
Possibly related PRs
Poem
Pre-merge checks and finishing touches❌ Failed checks (1 warning, 1 inconclusive)
✅ Passed checks (1 passed)
✨ Finishing touches
🧪 Generate unit tests (beta)
Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out. Comment |
![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 (1)
apps/website/src/app/components/HeroSection/HeroSection.tsx (1)
122-141: New “Manage Terminals” option is wired correctly; consider tightening types and confirm assetThe new selector label, gradient, and GIF entry are consistent and should work as intended. Two small follow‑ups:
- Type-safety improvement (optional)
To ensure every selector option always has a gradient and GIF, you can narrow the map keys to the selector union:-const SELECTOR_OPTIONS = [ - "Use Agents", - "Manage Terminals", - "Open Worktrees", - "Customize Themes", -] as const; - -const BACKGROUND_GRADIENTS: Record<string, string> = { +const SELECTOR_OPTIONS = [ + "Use Agents", + "Manage Terminals", + "Open Worktrees", + "Customize Themes", +] as const; + +type SelectorOption = (typeof SELECTOR_OPTIONS)[number]; + +const BACKGROUND_GRADIENTS: Record<SelectorOption, string> = { "Use Agents": "from-rose-900/80 via-pink-950/70 to-rose-950/80", "Manage Terminals": "from-amber-900/80 via-yellow-950/70 to-orange-950/80", "Open Worktrees": "from-blue-900/80 via-blue-950/70 to-blue-950/80", "Customize Themes": "from-emerald-900/80 via-teal-950/70 to-emerald-950/80", }; -const DEMO_GIFS: Record<string, string> = { +const DEMO_GIFS: Record<SelectorOption, string> = { "Use Agents": "/hero/use-agents.gif", "Manage Terminals": "/hero/manage-terminals.gif", "Open Worktrees": "/hero/open-worktrees.gif", "Customize Themes": "/hero/change-themes.gif", };
- Verify GIF asset exists
Ensure/hero/manage-terminals.gifis present under the Next.jspublic/herodirectory so the new option doesn’t render a broken image.
📜 Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro
⛔ Files ignored due to path filters (5)
apps/website/public/hero/manage-terminals.gifis excluded by!**/*.gifassets/change-themes.gifis excluded by!**/*.gifassets/create-tabs.gifis excluded by!**/*.gifassets/create-worktree.gifis excluded by!**/*.gifassets/example.gifis excluded by!**/*.gif
📒 Files selected for processing (3)
README.md(1 hunks)apps/website/src/app/BRAND_GUIDELINES.md(0 hunks)apps/website/src/app/components/HeroSection/HeroSection.tsx(1 hunks)
💤 Files with no reviewable changes (1)
- apps/website/src/app/BRAND_GUIDELINES.md
🧰 Additional context used
📓 Path-based instructions (2)
**/*.{ts,tsx}
📄 CodeRabbit inference engine (AGENTS.md)
**/*.{ts,tsx}: Avoid usinganytype - use explicit types instead for type safety
Use camelCase for variable and function names following existing codebase patterns
Keep diffs minimal with targeted edits only - avoid unnecessary changes when making modifications
Follow existing patterns and match the codebase style when writing new code
Files:
apps/website/src/app/components/HeroSection/HeroSection.tsx
**/components/**/*.tsx
📄 CodeRabbit inference engine (AGENTS.md)
**/components/**/*.tsx: Create one folder per component with structure:ComponentName/ComponentName.tsx+index.tsfor barrel export
Co-locate tests next to the component file they test (e.g.,ComponentName.test.tsx)
Co-locate dependencies (utils, hooks, constants, config, stories) next to the file using them
Use nestedcomponents/subdirectory within a parent component only if a sub-component is used 2+ times within that parent; otherwise keep it in the parent'scomponents/folder
One component per file - avoid multi-component files
Files:
apps/website/src/app/components/HeroSection/HeroSection.tsx
| ### Usage | ||
|
|
||
| For each parallel tasks, Superset uses git worktree to clone a new branch on your machine. Automate copying env variables, installing dependencies, etc. through a setup script `./superset/setup.json` | ||
| For each parallel tasks, Superset uses git worktrees to clone a new branch on your machine. Automate copying env variables, installing dependencies, etc. through a setup script (`./superset/setup.json`) | ||
|
|
There was a problem hiding this comment.
Minor grammar fix in usage sentence
“Each” doesn’t agree with plural “tasks”. Suggest singular:
-For each parallel tasks, Superset uses git worktrees to clone a new branch on your machine. Automate copying env variables, installing dependencies, etc. through a setup script (`./superset/setup.json`)
+For each parallel task, Superset uses git worktrees to clone a new branch on your machine. Automate copying env variables, installing dependencies, etc. through a setup script (`./superset/setup.json`)🤖 Prompt for AI Agents
In README.md around lines 51 to 54, the phrase "For each parallel tasks" is
grammatically incorrect; change it to "For each parallel task" (singular) so the
subject and noun agree, and ensure the sentence reads: "For each parallel task,
Superset uses git worktrees to clone a new branch on your machine." Keep the
rest of the paragraph unchanged.
1 participant
Description
Related Issues
Type of Change
Testing
Screenshots (if applicable)
Additional Notes
Summary by CodeRabbit
New Features
Documentation
✏️ Tip: You can customize this high-level summary in your review settings.