feat: introduces a new showcase section for component documentation#108
Merged
MarcosvBueno merged 2 commits intodevelopfrom Jan 26, 2026
Merged
Conversation
|
The latest updates on your projects. Learn more about Vercel for GitHub.
|
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.
This pull request introduces a new showcase section for component documentation, allowing each component documentation page to include a visual preview alongside an example code snippet. The changes update both the documentation guide and an existing component doc to demonstrate how this new feature should be used.
🧩 Component Documentation Enhancements
Added an optional
showcasefield to theComponentDoctype, enabling components to display a visual preview together with the corresponding code snippet directly in their documentation.Updated the documentation guide (
COMPONENT_DOCS_GUIDE.md) to explain how to add ashowcasesection, including a new checklist item to ensure it is properly included when documenting components.Added a practical
showcaseexample to theCreativeTooltipcomponent documentation, demonstrating how to present multiple tooltip variants with both live previews and example code.