docs: clear up default message persistence behavior for chat rooms #3038
Conversation
|
Important Review skippedAuto reviews are disabled on this repository. Please check the settings in the CodeRabbit UI or the You can disable this status message by setting the ✨ Finishing touches🧪 Generate unit tests (beta)
Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out. Comment |
|
|
||
| A user can also update or delete a message, all users that are subscribed to the room will be notified of the changes. | ||
|
|
||
| **Note:** To support updates, deletions, and [reactions](/docs/chat/rooms/message-reactions), [message persistence](/docs/chat/rooms#persistence) is enabled by default for all chat rooms. |
There was a problem hiding this comment.
We have an Aside block type we can use here (which puts it in a nice callout box)
|
|
||
| ### Message persistence <a id="persistence"/> | ||
|
|
||
| The `::$chat` suffix applied to chat room channels enables intrinsic default behaviors that differ from standard Pub/Sub channels. One of the most important behaviors is message persistence. |
There was a problem hiding this comment.
This para is probably too much detail for the docs, I think we can remove it and let the following two do the talking.
| ### Message persistence <a id="persistence"/> | ||
|
|
||
| The `::$chat` suffix applied to chat room channels enables intrinsic default behaviors that differ from standard Pub/Sub channels. One of the most important behaviors is message persistence. | ||
|
|
There was a problem hiding this comment.
I don't think we need to add Unlike typical Pub/Sub channels. We should assume someone is coming into this with 0 knowledge of Pub/Sub.
Description
It was a bit unclear how persistence is managed for chat, so I've added a few lines to highlight how this works.
Checklist