Add WebRTC documentation for developers #1282
Merged
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
dannywillems
force-pushed
the
dw/document-webrtc
branch
6 times, most recently
from
b27d6e4 to
bb456ac
Compare
Add comprehensive WebRTC documentation to help engineers understand WebRTC fundamentals and OpenMina's implementation. The documentation covers NAT traversal, signaling protocols, ICE candidates, and OpenMina's specific WebRTC architecture including host resolution, signaling methods, and cryptographic authentication. Highlights Web Node importance for browser-based Mina protocol nodes and includes documentation link in the WebRTC module for easy reference.
Always good to have unit test for this kind of small methods. Bugs in parsing can cause the process to exit, therefore it is important to be sure that the methods handle the cases correctly.
It is multiple times referenced in the WebRTC document. Therefore it is worth having a small documentation to help when going through the documentation.
dannywillems
force-pushed
the
dw/document-webrtc
branch
2 times, most recently
from
413ed70 to
d68478c
Compare
dannywillems
force-pushed
the
dw/document-webrtc
branch
from
d68478c to
f858bc4
Compare
dannywillems
force-pushed
the
dw/document-webrtc
branch
from
11c0673 to
e5c9af3
Compare
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.
Can be reviewed commit by commit.
Add comprehensive WebRTC documentation to help engineers understand WebRTC fundamentals and OpenMina's implementation. The documentation covers NAT traversal, signaling protocols, ICE candidates, and OpenMina's specific WebRTC architecture including host resolution, signaling methods, and cryptographic authentication.
Highlights Web Node importance for browser-based Mina protocol nodes and includes documentation link in the WebRTC module for easy reference.