webrtc icon indicating copy to clipboard operation
webrtc copied to clipboard

add drawio diagram for examples

Open mohammadne opened this issue 3 years ago • 9 comments

progress

notes

  • on each example, press the architecture link to view online schema of the diagram

Reference issue

mohammadne avatar Oct 28 '21 08:10 mohammadne

@mohammadne fantastic work! I would love to add these. Could you also put the image in the README themselves?

A few changes

  • Instead of Callee and Caller can you do Offerer and Answerer
  • peer-connection -> PeerConnection
  • data-channel -> data channel
  • Reflect and play-from-disk has Request ICE Candidates twice

Sean-Der avatar Oct 28 '21 15:10 Sean-Der

Codecov Report

Merging #1999 (a2b772e) into master (bb0ac79) will decrease coverage by 0.55%. The diff coverage is n/a.

:exclamation: Current head a2b772e differs from pull request most recent head 91f2cf8. Consider uploading reports for the commit 91f2cf8 to get more accurate results

Impacted file tree graph

@@            Coverage Diff             @@
##           master    #1999      +/-   ##
==========================================
- Coverage   77.19%   76.64%   -0.56%     
==========================================
  Files          84       85       +1     
  Lines        8783     6225    -2558     
==========================================
- Hits         6780     4771    -2009     
+ Misses       1593     1045     -548     
+ Partials      410      409       -1     
Flag Coverage Δ
go 78.38% <ø> (-0.62%) :arrow_down:
wasm 70.95% <ø> (+0.67%) :arrow_up:

Flags with carried forward coverage won't be shown. Click here to find out more.

Impacted Files Coverage Δ
api.go 90.00% <0.00%> (-10.00%) :arrow_down:
stats.go 67.85% <0.00%> (-7.15%) :arrow_down:
internal/mux/muxfunc.go 66.66% <0.00%> (-6.07%) :arrow_down:
pkg/rtcerr/errors.go 5.00% <0.00%> (-5.00%) :arrow_down:
networktype.go 65.95% <0.00%> (-4.96%) :arrow_down:
rtptransceiver.go 83.17% <0.00%> (-4.49%) :arrow_down:
iceserver_js.go 55.55% <0.00%> (-4.45%) :arrow_down:
icecredentialtype.go 71.42% <0.00%> (-3.58%) :arrow_down:
rtpreceiver.go 69.66% <0.00%> (-3.40%) :arrow_down:
iceserver.go 91.66% <0.00%> (-2.93%) :arrow_down:
... and 75 more

Continue to review full report at Codecov.

Legend - Click here to learn more Δ = absolute <relative> (impact), ø = not affected, ? = missing data Powered by Codecov. Last update bb0ac79...91f2cf8. Read the comment docs.

codecov[bot] avatar Oct 28 '21 16:10 codecov[bot]

@mohammadne fantastic work! I would love to add these. Could you also put the image in the README themselves?

A few changes

  • Instead of Callee and Caller can you do Offerer and Answerer
  • peer-connection -> PeerConnection
  • data-channel -> data channel
  • Reflect and play-from-disk has Request ICE Candidates twice

yes, for sure

mohammadne avatar Oct 29 '21 04:10 mohammadne

Hi @Sean-Der

I just updated the pull-request to include your requested feature. I'll continue with this approach for all examples, let me know if current approach needs improvement.

Thanks alot :)

mohammadne avatar Oct 29 '21 08:10 mohammadne

HI @Sean-Der I'm done.

can you please check it! Thanks :)

mohammadne avatar Oct 31 '21 17:10 mohammadne

@Sean-Der

the only remaining diagram is for vnet, because currently I'm not vrey familiar with it, I'll create another pull-request for that in the future (maybe in the next week)

thanks for your awesome library :100:

mohammadne avatar Oct 31 '21 17:10 mohammadne

Fantastic work @mohammadne ! Thank you so much for contribution to Pion :)

I will review and merge first thing tomorrow. I think this will help people a lot.

Sean-Der avatar Nov 01 '21 02:11 Sean-Der

Hi @Sean-Der Is there any update about status of this pr ? thanks :)

mohammadne avatar Nov 07 '21 09:11 mohammadne

HI @Sean-Der I have updated the branch to resolve the conflicts. thanks

mohammadne avatar Feb 01 '22 06:02 mohammadne

Hi @mohammadne

I really regret that this didn't get in. It was my fault that I didn't do a better job of guiding this PR. I am going to work on this.

Since this PR had started Github added mermaidjs. I started porting to mermaidjs here. I put you as the author.

I started with data-channel, but I am planning on doing them all https://github.com/pion/webrtc/issues/2415. I understand if you are burned out/not interested in working on Pion (you didn't have a great experience). I would love to have you involved on this though!

Sean-Der avatar Feb 11 '23 05:02 Sean-Der