FCE-2708 Adds docs for data channels #219
Conversation
There was a problem hiding this comment.
Pull request overview
This PR adds comprehensive documentation for data channels in the web SDK, enabling developers to send and receive arbitrary binary data between peers in a room.
Changes:
- Added new documentation page explaining data channel concepts and usage patterns
- Updated connecting guide to reference the new data channels documentation
- Updated subproject commit references for web-client-sdk, python-server-sdk, js-server-sdk, protos, and fishjam-server
Reviewed changes
Copilot reviewed 7 out of 7 changed files in this pull request and generated no comments.
Show a summary per file
| File | Description |
|---|---|
| docs/how-to/client/data-channels.mdx | New documentation covering data channel types, broadcast communication, and implementation examples for chat and cursor sharing |
| docs/how-to/client/connecting.mdx | Added reference link to data channels documentation in the next steps section |
| packages/web-client-sdk | Updated subproject commit reference |
| packages/python-server-sdk | Updated subproject commit reference |
| packages/js-server-sdk | Updated subproject commit reference |
| api/protos | Updated subproject commit reference |
| api/fishjam-server | Updated subproject commit reference |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
czerwiukk
left a comment
czerwiukk
left a comment
There was a problem hiding this comment.
If we want to put the docs in the "how to" section, it could be something like "how to build a text chat". The explanation of what a data channel actually is and how it works falls better into the Explanation category.
We follow https://diataxis.fr/ approach for our docs. I should've shared this earlier, but forgor, sorry.
| 2. Subscribe to incoming messages | ||
| 3. Publish messages to other peers | ||
|
|
||
| ### Example: Simple Chat Messages |
There was a problem hiding this comment.
suggestion: How about moving this section to "how-to/features" as a "text chat" article? Both articles should link to each other like: "see how to build a text-chat using data channel" and "we will use data channels to send messages, check out the explanation to learn more"
Description
This PR adds docs related to data channels in web sdk.