Peer docs#2699
Merged
ProgrammerIn-wonderland merged 2 commits intomainfrom Mar 20, 2026
Merged
Conversation
Introduce documentation for the new Peer API (Peer.md) and detailed pages for serve, connect, and ensureTurnRelays. Add a playable peer chat example (playground/examples/peer-basic.html) and register it in examples.js. Add sidebar entries for the Peer docs (sidebar.js). Include CSS for the alpha notice banner and spacer in assets/style.css to surface the API's alpha status in the docs UI. Minor formatting update to examples.js export newline.
Expand the Peer API intro to highlight common use cases (multiplayer games, collaborative editing, real-time communication) and clarify that the API enables serverless P2P apps. Also remove the ";peer-basic" suffix from HTML code fences in connect.md and serve.md so example blocks render as standard HTML.
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.
Adds docs and playgroudn examples for the Peer API. Additionally, there is an alpha banner.