docs: split uniwind skill#583
Merged
Merged
Conversation
jpudysz
approved these changes
Jun 17, 2026
Collaborator
|
@coderabbitai review |
✅ Action performedReview finished.
|
|
No actionable comments were generated in the recent review. 🎉 ℹ️ Recent review info⚙️ Run configurationConfiguration used: defaults Review profile: CHILL Plan: Pro Run ID: 📒 Files selected for processing (1)
✅ Files skipped from review due to trivial changes (1)
📝 WalkthroughWalkthroughThe monolithic ChangesUniwind Skill Documentation Restructure
Estimated code review effort🎯 2 (Simple) | ⏱️ ~10 minutes Possibly related PRs
Suggested reviewers
Poem
🚥 Pre-merge checks | ✅ 5✅ Passed checks (5 passed)
✏️ Tip: You can configure your own custom pre-merge checks in the settings. ✨ 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: 2
🧹 Nitpick comments (4)
skills/uniwind/references/setup.md (1)
64-64: ⚡ Quick winClarify when Vite configuration is needed.
Line 64 conditions the Vite section on "If user has storybook setup", but the configuration shown is not Storybook-specific. This phrasing risks causing users without Storybook to skip this section even if they use Vite in their project. Clarify whether Vite configuration is:
- Required for all projects that use Vite
- Optional/recommended for Storybook specifically
- Or a different scenario entirely
📝 Suggested clarification
Replace line 64 with one of these options:
Option 1 (if Vite is needed for any Vite user):
-If user has storybook setup, add extra vite config: +If your project uses Vite (e.g., for Storybook or a web companion app), add this config:Option 2 (if this is Storybook-specific):
-If user has storybook setup, add extra vite config: +For Storybook setups using Vite, add this config:🤖 Prompt for AI Agents
Verify each finding against current code. Fix only still-valid issues, skip the rest with a brief reason, keep changes minimal, and validate. In `@skills/uniwind/references/setup.md` at line 64, The conditional statement "If user has storybook setup, add extra vite config:" on line 64 is ambiguous and risks causing users without Storybook to skip this section even if they need Vite configuration. Replace this line with clearer wording that explicitly specifies whether the Vite configuration is required for all projects using Vite, is optional/recommended specifically for Storybook users, or applies to a different scenario. The revised condition should remove any ambiguity about which users need to follow the configuration section that follows.skills/uniwind/references/pro.md (2)
301-303: ⚖️ Poor tradeoffExpand Suspense support explanation.
The explanation is vague: "keeps the C++ shadow entries alive" and "when the tree unsuspends, styles are already up to date" do not clearly describe the mechanism. Users may not understand why this prevents stale theme flashes or when this behavior is triggered. Consider explaining: (1) that Uniwind tracks theme/runtime state independently of React's suspend/unsuspend lifecycle, and (2) that style updates are queued and applied on unsuspend.
🤖 Prompt for AI Agents
Verify each finding against current code. Fix only still-valid issues, skip the rest with a brief reason, keep changes minimal, and validate. In `@skills/uniwind/references/pro.md` around lines 301 - 303, The Suspense Support section explanation is too vague about the mechanism preventing stale theme flashes. Expand the explanation in this section to clarify that Uniwind independently tracks theme and runtime state separate from React's suspend/unsuspend lifecycle, and that style updates are queued during the suspension period and then applied when the tree unsuspends. This will help users understand both the "why" (preventing flashes) and the "when" (during and after suspension) of this behavior.
98-110: ⚖️ Poor tradeoffExplain component auto-swap detection mechanism.
The document states "Components auto-swap to Animated versions when animation classes detected," but does not explain the detection mechanism or edge cases. When are classes "detected" — at compile time, parse time, or runtime? What happens if animation classes are added dynamically? Can detection be disabled or customized?
🤖 Prompt for AI Agents
Verify each finding against current code. Fix only still-valid issues, skip the rest with a brief reason, keep changes minimal, and validate. In `@skills/uniwind/references/pro.md` around lines 98 - 110, Expand the documentation in the auto-swap components section to explain the detection mechanism in detail. Clarify when the auto-swap detection occurs (compile-time, parse-time, or runtime), specify what constitutes "animation classes detected" (e.g., which specific class names trigger the swap), document how the system handles dynamically added animation classes, and note whether this auto-swap behavior can be disabled, customized, or configured. Add this information as a detailed explanation paragraph before or after the components table to provide developers with complete understanding of how and when the auto-swap mechanism is triggered.skills/uniwind/references/troubleshooting.md (1)
74-90: ⚡ Quick winClarify when culori selective resolver is needed.
The selective resolver code (line 81) includes both
'uniwind'and'culori'in the module check. Isculorialways required, or only when using certain color features? The comment should clarify whether this is a mandatory requirement or an optional safety measure. Consider adding a note explaining whenculorisupport is needed.🤖 Prompt for AI Agents
Verify each finding against current code. Fix only still-valid issues, skip the rest with a brief reason, keep changes minimal, and validate. In `@skills/uniwind/references/troubleshooting.md` around lines 74 - 90, Add clarification to the selective resolver documentation in the unstable_enablePackageExports section to explain when culori support is needed. Include a comment or note above or within the resolveRequest function that specifies whether culori is always required in the module check, or if it should only be included when using specific color features. If culori is optional, provide guidance on when developers should include it versus when they can safely remove it from the moduleName check that includes both 'uniwind' and 'culori'.
🤖 Prompt for all review comments with AI agents
Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.
Inline comments:
In `@skills/uniwind/references/troubleshooting.md`:
- Around line 121-166: The FAQ section contains multiple references to "above"
sections that have been moved to separate documentation files during the skill
split. Replace all instances of "above" phrasing (such as "See the **Fonts**
section above", "See the **Data Selectors** section above", "See the
**Gradients** section above", "See the **Safe Area Utilities** section above",
and "See the **UI Kit Compatibility** section above") with explicit cross-file
markdown links that point to the correct reference files: `css-and-utilities.md`
for Fonts and Gradients, `variants-and-selectors.md` for Data Selectors and Safe
Area Utilities, `integrations.md` for UI Kit Compatibility, and `theming.md` for
Theming. Use markdown link syntax (e.g.,
`[filename](./filename.md#section-anchor)`) instead of "above" phrasing to
provide clear navigation across the split documentation structure.
- Line 72: In the troubleshooting table within the Pro component styles row,
locate the cell containing the truncated property name "experimental.defaul..."
and replace it with the complete and correct property name
"experimental.defaultStyles: true" to ensure the configuration instruction is
fully visible and accurate in the documentation.
---
Nitpick comments:
In `@skills/uniwind/references/pro.md`:
- Around line 301-303: The Suspense Support section explanation is too vague
about the mechanism preventing stale theme flashes. Expand the explanation in
this section to clarify that Uniwind independently tracks theme and runtime
state separate from React's suspend/unsuspend lifecycle, and that style updates
are queued during the suspension period and then applied when the tree
unsuspends. This will help users understand both the "why" (preventing flashes)
and the "when" (during and after suspension) of this behavior.
- Around line 98-110: Expand the documentation in the auto-swap components
section to explain the detection mechanism in detail. Clarify when the auto-swap
detection occurs (compile-time, parse-time, or runtime), specify what
constitutes "animation classes detected" (e.g., which specific class names
trigger the swap), document how the system handles dynamically added animation
classes, and note whether this auto-swap behavior can be disabled, customized,
or configured. Add this information as a detailed explanation paragraph before
or after the components table to provide developers with complete understanding
of how and when the auto-swap mechanism is triggered.
In `@skills/uniwind/references/setup.md`:
- Line 64: The conditional statement "If user has storybook setup, add extra
vite config:" on line 64 is ambiguous and risks causing users without Storybook
to skip this section even if they need Vite configuration. Replace this line
with clearer wording that explicitly specifies whether the Vite configuration is
required for all projects using Vite, is optional/recommended specifically for
Storybook users, or applies to a different scenario. The revised condition
should remove any ambiguity about which users need to follow the configuration
section that follows.
In `@skills/uniwind/references/troubleshooting.md`:
- Around line 74-90: Add clarification to the selective resolver documentation
in the unstable_enablePackageExports section to explain when culori support is
needed. Include a comment or note above or within the resolveRequest function
that specifies whether culori is always required in the module check, or if it
should only be included when using specific color features. If culori is
optional, provide guidance on when developers should include it versus when they
can safely remove it from the moduleName check that includes both 'uniwind' and
'culori'.
🪄 Autofix (Beta)
Fix all unresolved CodeRabbit comments on this PR:
- Push a commit to this branch (recommended)
- Create a new PR with the fixes
ℹ️ Review info
⚙️ Run configuration
Configuration used: defaults
Review profile: CHILL
Plan: Pro
Run ID: 1cbe2c17-7377-4d70-8149-d8f6c0ab228e
📒 Files selected for processing (10)
skills/uniwind/SKILL.mdskills/uniwind/references/component-bindings.mdskills/uniwind/references/css-and-utilities.mdskills/uniwind/references/integrations.mdskills/uniwind/references/pro.mdskills/uniwind/references/setup.mdskills/uniwind/references/styling-patterns.mdskills/uniwind/references/theming.mdskills/uniwind/references/troubleshooting.mdskills/uniwind/references/variants-and-selectors.md
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary by CodeRabbit