Docs: Fix incorrect value for includePrimary in documentation#34792
Conversation
|
No actionable comments were generated in the recent review. 🎉 ℹ️ Recent review info⚙️ Run configurationConfiguration used: Organization UI Review profile: CHILL Plan: Pro Run ID: 📒 Files selected for processing (1)
📝 WalkthroughWalkthroughThe ChangesStories Block Documentation
🎯 1 (Trivial) | ⏱️ ~2 minutes 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 |
|
Hi @NlDev-hub, Due to a recent high volume of unreviewed AI-generated PRs, we are requesting verification and proof that the implemented fix actually works. Please provide a simple GIF/Video or image of how the fix works, optimally with before-and-after comparisons. Thank you for your understanding! |
|
Thanks for checking. I verified the PR locally against The change is documentation-only. Before, the note said the empty-render case happened with Before/after proof of the exact changed docs section: |
|
Sorry about that, my triage script got a little too eager. |
jonniebigodes
left a comment
There was a problem hiding this comment.
@NlDev-hub thanks for taking the time to put together this pull request and helping us improve the documentation. I've checked it and all looks good on my end.
Will gladly merge this once the checklist clears
Have a great day.
Stay safe
Fixes #24167.
The
Storiesdocs currently say a single-story file renders nothing whenincludePrimary={true}. The current block implementation only omits the primary story whenincludePrimary={false}, and then returns nothing if no stories remain.This updates the note to match that behavior.
Checks:
git diff --checkNote: I could not run the repo formatter locally because yarn/corepack were unavailable in my environment.
Manual testing
Open documentation site on local branch and see changes. N/A.
Summary by CodeRabbit
includePrimaryprop behavior and empty-render scenarios.