Clarify streams in readme #745
Open
Conversation
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
…d examples of server side code
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
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.
While learning how to use Turbo Streams recently, I was confused by a few things in the README.
First, having the "Testing Turbo Stream Broadcasts" details immediately after the brief introduction to Streams made me think at first that the readme didn't have anything else to say about how to implement Streams, so the first commit moves those details into the existing "Testing" section. This should make the following "Installation" and "Usage" sections more obvious.
Second, I wasn't clear on what sorts of broadcasting
turbo-railssupports -- only callbacks from models, or also code outside the model context? From what I've gathered, calling broadcast methods onTurbo::StreamsChannel, as in the added snippet, is a common practice, though I haven't seen official docs on that outside of the linked code comment.If I'm wrong or missing anything around expected usage of Streams, happy to rework these changes accordingly.