-
-
Notifications
You must be signed in to change notification settings - Fork 2.3k
Components refactor #1629
Components refactor #1629
Conversation
* refer to display components rather than components v2 (phrasing only present in the flag, not upstream documentation) * use danger components to mention notification difference compared to embeds * move caveats to top in warning admonition
9849f78 to
13b261e
Compare
* don't mention update where it isn't applicable * use correct field name for poll * editing requires not supported fields to be set to null * mention that attached files need to be referenced
|
I used to reference the display components as "Components V2", since that is what basically everyone is calling them. People might search for "How to use components v2 discord bot" rather than "How to use display components discord bot" as well, so in my opinion it should be called "Components V2" throughout the article. People might think "Huh I ain't looking for display components, I need a guide for Components V2". |
|
i understand the idea and arguably better discovery! we do stick quite strictly to the official terminology across the library and try to stay consistent with that idea on the guide. "components v2" was more of a working title and isn't really reflected apart from blogs/announcements and the flag name itself. in upstream it's always just referenced as components, which imo makes more sense. cv2 isn't really a replacement/new version of already existing components (buttons, selects, and action rows), which the "v2" suffix suggests, but an extension of the component system to move away from the fairly limited embed constraints to a more extendable and modular system. (maybe a new wave of components will be "cv3" - we will see ^^) if you have other feedback, feel free to leave a review and thanks again for the original PR! |
|
Ah, that indeed makes a lot more sense to me now. Thanks for explaining! In this way I agree with the changes you have made. |
|
Looks like this PR broke the entire message-components section of the docs. |
|
Where did you get that from? |
|
Distinguishes between "Display Components" and "Interactive Components" now: https://discordjs.guide/popular-topics/display-components.html "Message Components" has a lot of ambiguity as both the components added with and depending on ComponentsV2 as well as the old, interactive components could fall under "components on a message"
That would be good to know so we can update things pointing to the (now broken) page |
|
I used the CMD+K Search on the discordjs.guide website for "components" and every page 404'd. Also, all the main google results 404'd. |
|
thanks! that makes sense - i think we need to refresh our search provider's crawl (algolia) - the display components section wont't surface at all either, since the search still has the old state. |
|
thanks again for the reminder - the guide has now been reindexed and search should work and not result in 404s now |
Please describe the changes this PR makes and why it should be merged:
TODO: