docs: add v4 release banner and changelog entry#3337
Conversation
- Add Vibe4Banner component to storybook welcome page with a pastel purple/blue gradient and inline migration guide link - Add v4.0.0 entry to @vibe/core CHANGELOG with a summary of breaking changes and a link to the full migration guide
Review Summary by QodoAdd v4 release banner and changelog entry
WalkthroughsDescription• Adds Vibe4Banner component to Storybook welcome page • Displays v4 release announcement with migration guide link • Adds v4.0.0 CHANGELOG entry documenting breaking changes • Banner styled with pastel purple/blue gradient bubbles Diagramflowchart LR
A["Vibe4Banner Component"] -->|"Styled with gradients"| B["SCSS Module"]
A -->|"Integrated into"| C["Storybook Preview"]
D["v4.0.0 CHANGELOG Entry"] -->|"Documents"| E["Breaking Changes"]
E -->|"Links to"| F["Migration Guide"]
File Changes1. packages/docs/src/pages/welcome/banner/Vibe4Banner.tsx
|
Code Review by Qodo
1. Vibe4Banner missing data-vibe
|
|
|
||
| const Vibe4Banner: React.FC = () => { | ||
| return ( | ||
| <div className={styles.vibe4Banner}> |
There was a problem hiding this comment.
1. vibe4banner missing data-vibe 📘 Rule violation ✓ Correctness
The Vibe4Banner root element is missing the required [data-vibe] attribute, reducing consistency for test automation and DOM identification. This violates the component root-attribute requirement.
Agent Prompt
## Issue description
`Vibe4Banner` is missing the required `[data-vibe]` attribute on its root element.
## Issue Context
The compliance checklist requires all components to render a root element that includes `[data-vibe]` for consistent DOM identification and testing.
## Fix Focus Areas
- packages/docs/src/pages/welcome/banner/Vibe4Banner.tsx[6-22]
ⓘ Copy this prompt and use it to remediate the issue with your preferred AI generation tools
|
|
||
| return ( | ||
| <> | ||
| {isWelcomePage && <Vibe4Banner />} | ||
| {isWelcomePage && <FloatingObjects />} |
There was a problem hiding this comment.
2. Welcome detection may fail 🐞 Bug ✓ Correctness
Vibe4Banner rendering depends on isWelcomePage checking
window.location.href.includes("id=welcome"), which won’t match the repo’s common
/?path=/docs/... routing; the banner can silently never render on the Welcome docs page. This
breaks the PR’s intended behavior (banner shown on Welcome only) for path-based navigation.
Agent Prompt
## Issue description
`Vibe4Banner` is currently shown only when `window.location.href.includes("id=welcome")`. In this repo, many internal Storybook links use `/?path=/docs/...`, so Welcome can be reached without any `id=...` query param. As a result, the banner can fail to appear even on the Welcome page.
## Issue Context
- You already have access to the Storybook `context` object in the docs `container`.
- The codebase uses `/?path=/docs/...` links for internal navigation.
## Fix Focus Areas
- packages/docs/.storybook/preview.tsx[69-83]
## Suggested direction
Prefer using `context` (e.g., `context.title === "Welcome"`, `context.id === "welcome--docs"`, and/or `context.viewMode === "docs"`) instead of parsing `window.location.href`. If you want to preserve compatibility with older URL formats, you can support both by checking `URLSearchParams` for `id` and `path`.
ⓘ Copy this prompt and use it to remediate the issue with your preferred AI generation tools
Summary
Vibe4Bannercomponent to the Storybook welcome page, styled similarly to the previous Monday Vibe banner (pastel purple/blue gradient bubbles, inline text)v4.0.0entry to@vibe/coreCHANGELOG with a concise summary of breaking changes and a link to the full migration guide