Add Transceiver guide

[mickel8]

No description provided.

[codecov]

Codecov Report

Merging #56 (b985785) into master (8bf58fa) will not change coverage.
Report is 1 commits behind head on master.
The diff coverage is n/a.

Additional details and impacted files

@@           Coverage Diff           @@
##           master      #56   +/-   ##
=======================================
  Coverage   89.02%   89.02%           
=======================================
  Files          25       25           
  Lines        1057     1057           
=======================================
  Hits          941      941           
  Misses        116      116           

---

Continue to review full report in Codecov by Sentry.

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

[LVala]

Some general remarks:

• use Grammarly or paste the text into ChatGPT and tell it to fix the grammar and punctuation,
• like I mentioned somewhere, I feel like the guide is missing a glossary, as a lot of the terminology might be obvious for us but not necessarily for someone who just used the JS API and didn't really look into SDP and stuff. I would also move the explanations of transceiver properties (direction etc.) there,
• the guide goes quite in-depth from the very beginning, I would love to see some introductory example (maybe showing differences between just using addTrack and using transceivers directly)
• maybe it would be nice to crate a section where all of the API functions used later on are explained (focusing on intuition),
• link to some introductory guide to WebRTC API in the beginning of the guide?
• what do you think of adding a nice diagram showing relations between transceivers/senders/transports etc. with the new ex_doc diagram feature?

That's it for now, but if anything comes to my mind regarding the guide, I'm going to share it.

[mickel8]

Some general remarks:

use Grammarly or paste the text into ChatGPT and tell it to fix the grammar and punctuation,

done

like I mentioned somewhere, I feel like the guide is missing a glossary, as a lot of the terminology might be obvious for us but not necessarily for someone who just used the JS API and didn't really look into SDP and stuff. I would also move the explanations of transceiver properties (direction etc.) there,

the guide goes quite in-depth from the very beginning, I would love to see some introductory example (maybe showing differences between just using addTrack and using transceivers directly)

maybe it would be nice to crate a section where all of the API functions used later on are explained (focusing on intuition),
what do you think of adding a nice diagram showing relations between transceivers/senders/transports etc. with the new ex_doc diagram feature?

Great point! However, this is quite a lot of work and the idea was to have more advanced guide for people who more or less know what webrtc is and are looking for deep understanding of transceivers and what they can do with them.

I think that all of the things you listed i.e. glossary, more basic examples, diagrams, API explanation is for another section(s) and for another task.

For now I would favor renaming the guide to Mastering Transceivers or something like this and stating at the beginning what's the purpose of this guide.

link to some introductory guide to WebRTC API in the beginning of the guide?

👍

[LVala]

Great point! However, this is quite a lot of work and the idea was to have more advanced guide for people who more or less know what webrtc is and are looking for deep understanding of transceivers and what they can do with them.

I think that all of the things you listed i.e. glossary, more basic examples, diagrams, API explanation is for another section(s) and for another task.

For now I would favor renaming the guide to Mastering Transceivers or something like this and stating at the beginning what's the purpose of this guide.

Sure

[LVala]

Like I said earlier, maybe it would be nice to get Jellyfish guys to read through this to get and outsider's perspective, but otherwise -- sgtm.

[LVala]

Firstly, I suppose it shouldn't look like this...

Also, I realised that, in the JS examples, you don't use const or let keywords, which is fine for console I guess, but you will need to add it when copying the examples to standalone script (at least I believe so, I'm no JS expert).