added reference docs for collab and presence - #32
Merged
Conversation
smoores-dev
reviewed
May 28, 2026
| } | ||
|
|
||
| /** | ||
| * Have the client start listening for remote commits. This function should only be called once. |
Member
There was a problem hiding this comment.
Suggested change
| * Have the client start listening for remote commits. This function should only be called once. | |
| * Start listening for remote commits. | |
| * | |
| * This function should only be called once. |
| /** | ||
| * @param redisUrl - the url for your Redis cluster | ||
| * @param timeout - the maximum time the broadcast manager should listen for changes | ||
| * to a document before returning an empty result |
Member
There was a problem hiding this comment.
Huh, does this work? I feel like these should be on the individual properties — @param is for function args, I think
Contributor
Author
There was a problem hiding this comment.
definitely does not work. Fixed
smoores-dev
approved these changes
May 28, 2026
Comment on lines
+38
to
+41
| // Todo: The example in this doc rely's on some react context, how to show it otherwise | ||
| // It feels useful to show that you use receiveCommitTransaction to merge the editor | ||
| // state, but that might just be because I wouldn't know how to do it otherwise. | ||
| // See the doc in the Presence client config's receiveIndicators for an alternative approach. |
Member
There was a problem hiding this comment.
We can remove this TODO now yeah?
pdiffley
added a commit
that referenced
this pull request
Jun 5, 2026
* added reference docs for collab and presence * fixed typos * fixes * rebuilt reference docs * resolved issues * fixed formatting * regen and format docs
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
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
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.
No description provided.