Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

add drawio diagram for examples #1999

Closed
wants to merge 52 commits into from
Closed

Conversation

mohammadne
Copy link
Contributor

@mohammadne mohammadne commented Oct 28, 2021

@mohammadne mohammadne marked this pull request as draft October 28, 2021 11:25
@mohammadne mohammadne changed the title add reflect drawio diagram add examples drawio diagram Oct 28, 2021
@Sean-Der
Copy link
Member

Sean-Der commented Oct 28, 2021

@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

@codecov
Copy link

codecov bot commented Oct 28, 2021

Codecov Report

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

❗ 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%) ⬇️
wasm 70.95% <ø> (+0.67%) ⬆️

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%) ⬇️
stats.go 67.85% <0.00%> (-7.15%) ⬇️
internal/mux/muxfunc.go 66.66% <0.00%> (-6.07%) ⬇️
pkg/rtcerr/errors.go 5.00% <0.00%> (-5.00%) ⬇️
networktype.go 65.95% <0.00%> (-4.96%) ⬇️
rtptransceiver.go 83.17% <0.00%> (-4.49%) ⬇️
iceserver_js.go 55.55% <0.00%> (-4.45%) ⬇️
icecredentialtype.go 71.42% <0.00%> (-3.58%) ⬇️
rtpreceiver.go 69.66% <0.00%> (-3.40%) ⬇️
iceserver.go 91.66% <0.00%> (-2.93%) ⬇️
... 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.

@mohammadne
Copy link
Contributor Author

@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
Copy link
Contributor Author

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 mohammadne changed the title add examples drawio diagram add drawio diagram for examples Oct 29, 2021
@mohammadne mohammadne marked this pull request as ready for review October 31, 2021 13:49
@mohammadne
Copy link
Contributor Author

HI @Sean-Der
I'm done.

can you please check it!
Thanks :)

@mohammadne
Copy link
Contributor Author

mohammadne commented Oct 31, 2021

@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 💯

@Sean-Der
Copy link
Member

Sean-Der commented Nov 1, 2021

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.

@mohammadne
Copy link
Contributor Author

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

@Sean-Der Sean-Der added this to the 3.2.0 milestone Jan 24, 2022
@mohammadne
Copy link
Contributor Author

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

@Sean-Der Sean-Der removed this from the 3.2.0 milestone May 22, 2022
@Sean-Der
Copy link
Member

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 #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 Sean-Der closed this Feb 11, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

2 participants