docs(ui): add stories for blog index page#2679
docs(ui): add stories for blog index page#2679IestynGage wants to merge 1 commit intonpmx-dev:mainfrom
Conversation
|
The latest updates on your projects. Learn more about Vercel for GitHub.
2 Skipped Deployments
|
|
No actionable comments were generated in the recent review. 🎉 ℹ️ Recent review info⚙️ Run configurationConfiguration used: Path: .coderabbit.yaml Review profile: CHILL Plan: Pro Run ID: 📒 Files selected for processing (1)
🚧 Files skipped from review as they are similar to previous changes (1)
📝 WalkthroughSummary by CodeRabbit
WalkthroughA new Storybook story file is added for the Blog page component at ChangesBlog Component Story
Suggested reviewers
🚥 Pre-merge checks | ✅ 4✅ Passed checks (4 passed)
✏️ Tip: You can configure your own custom pre-merge checks in the settings. ✨ Finishing Touches🧪 Generate unit tests (beta)
Tip 💬 Introducing Slack Agent: The best way for teams to turn conversations into code.Slack Agent is built on CodeRabbit's deep understanding of your code, so your team can collaborate across the entire SDLC without losing context.
Built for teams:
One agent for your entire SDLC. Right inside Slack. 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 |
|
Hello! Thank you for opening your first PR to npmx, @IestynGage! 🚀 Here’s what will happen next:
|
Codecov Report✅ All modified and coverable lines are covered by tests. 📢 Thoughts on this report? Let us know! |
|
@cylewaitforit if you have time would you be able to take a look? no rush or pressure! |
There was a problem hiding this comment.
The new story renders fine in the PR's deployed storybook .
@ghostdevv I don't have access to check the Chromatic tests anymore so you may want to check what the visual regression tests capture.
It looks like the blogs that are being displayed are live data. So my assumption is that would probably mean the chromatic tests would suddenly be out of date when a new blog post is added.
So while I know both are ultimately wanted, we would need to decide if disabling visual regression tests on this page to start would be a blocker to merging or if increasing the coverage of our documented pages is a fine enough short term goal.
If documenting to start is the more important goal then we could add the chromatic parameter to disable.
const meta = {
component: Blog,
parameters: {
layout: 'fullscreen",
// Disables Chromatic's snapshotting on a component level
chromatic: { disableSnapshot: true },
},
decorators: [pageDecorator],
} satisfies Meta<typeof Blog>;https://www.chromatic.com/docs/disable-snapshots/#with-storybook
We would probably want to then add a follow up issue to mock out the blog posts in order to re-enable snapshots.
There was a problem hiding this comment.
Update:
I have access to the chromatic tests again and understandably the snapshot has the same live data. So I think my assumption that new blog data would cause the snapshot to become outdated seems correct.
🔗 Linked issue
#2150
🧭 Context
Noticed this issue still had missing storybooks and it was labelled with Help wanted, so I added the storybook.
📚 Description
Added the storybook for the blog index. Seems to be working just fine. I looked at the other page storybooks and followed the convention used.