Skip to content
This repository was archived by the owner on Oct 5, 2025. It is now read-only.

Conversation

@almostSouji
Copy link
Member

@almostSouji almostSouji commented Jun 15, 2025

Please describe the changes this PR makes and why it should be merged:

  • Phrasing improvements
  • Switch from "components v2" to "display components" (v2 is never mentioned apart from the flag name in upstream docs)
  • Switch from "message component" to "interactive component" (components v2 could still be understood as "message components" as they are also part of the message, so making a distinction here seems appropriate)
  • Be more explicit about warning regarding accidental notifications caused by difference to embed behavior
  • Move caveats of using cv2 to the top as warning admonition

TODO:

  • After merge: link in FAQ post in discord

* 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
@almostSouji almostSouji force-pushed the components-refactor branch from 9849f78 to 13b261e Compare June 15, 2025 12:16
* 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
@PakjeBecel
Copy link
Contributor

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".

@almostSouji
Copy link
Member Author

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!

@PakjeBecel
Copy link
Contributor

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.

@almostSouji almostSouji merged commit b5b19f7 into main Jun 21, 2025
6 checks passed
@almostSouji almostSouji deleted the components-refactor branch June 21, 2025 11:54
@scottlangille
Copy link

Looks like this PR broke the entire message-components section of the docs.

https://discordjs.guide/message-components (404)

@Jiralite
Copy link
Member

Where did you get that from?

@almostSouji
Copy link
Member Author

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"

Where did you get that from?

That would be good to know so we can update things pointing to the (now broken) page
I'm not entirely sure how redirects would work the the vuepress plugin we use, but that might also be worth looking into.

@scottlangille
Copy link

scottlangille commented Jun 21, 2025

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.

@almostSouji
Copy link
Member Author

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.

@almostSouji
Copy link
Member Author

thanks again for the reminder - the guide has now been reindexed and search should work and not result in 404s now
(granted, with the updated wording, of course)

Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.

Projects

None yet

Development

Successfully merging this pull request may close these issues.

6 participants