-
-
Notifications
You must be signed in to change notification settings - Fork 32.5k
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
[docs] Iterating on recent Joy UI Component page updates #35162
[docs] Iterating on recent Joy UI Component page updates #35162
Conversation
|
@oliviertassinari Moving the conversation from #35152—
cc @danilo-leal and @siriwatknp I would love to get your thoughts on these questions. |
|
|
OK, I'm cool with removing the Usage section altogether, and ensuring that the Basics section includes a very basic demo that can serve as a more useful replacement for what the Usage section attempts to communicate. In situations where the Usage section might provide details that aren't covered elsewhere, I'll try moving them to Basics or the Introduction. |
After reflecting on @siriwatknp's comment above, I agree that the import—specifically, being able to copy and paste it—is the most useful part of the Usage section code snippet. I moved this to the Basics section. I also added imports for the "Usage with" sections that involve other Joy UI components, so those can be easily copied and pasted in as well. I think it also helps to quickly visually clarify that this section involves introducing a new component. |
Thanks for the clean new Alert demo @oliviertassinari! This PR should be ready to go, and now I think we have a much better template to proceed with. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
👍 Well done!
Co-authored-by: Olivier Tassinari <[email protected]>
Co-authored-by: Olivier Tassinari <[email protected]>
Part of #33998
Following #34858, #35152, and #34838, as well as some internal discussions with the Core team about these docs, I wanted to do a quick second pass on these three pages (Alert, Aspect Ratio, and Avatar) together to apply some structural changes based on what we've discovered so far.
Changes include:
I had intended to include these edits with my revision of the Autocomplete page, but because that doc is so huge, it really needs its own PR. It's shown me some structural things we need to account for as these pages get bigger—namely, that if everything is classified as "Customization," then this header starts to lose meaning. We also need to be intentional about the order in which information is presented under the Customization header, to deliver a more consistent experience across the docs.