docs(contributing): note when items.color is required#37
Merged
Conversation
When a prop is typed via another component (e.g. `color?: AvatarProps['color']`), the docs generator cannot resolve the palette from the host theme's `variants.color`. The dropdown ends up empty unless the component-code block declares `items.color` explicitly. Document this in the `### Dropdown Items` section, with pointers to the canonical fixes in `user.md` (`275c8b0b`-style fix on `User`) and `error.md` (`275c8b0b docs(Error): update color list`). Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com>
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
1 participant
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
Documents the edge case discovered while landing #36 (Error) and applied to #27 (User): when a component prop is typed via another component (e.g.
color?: AvatarProps['color']), the docs generator cannot resolve the palette from the host theme'svariants.color, and the dropdown ends up empty. The fix is to declareitems.colorexplicitly in the::component-codeblock.Adds a
::noteblock right after the existing### Dropdown Itemsexample in.github/contributing/documentation.md, with pointers to the canonical fixes already indocs/content/docs/2.components/user.mdanddocs/content/docs/2.components/error.md.Test plan
### Dropdown Items🤖 Generated with Claude Code