Skip to content

Add "For Developers" guides - Debugging, Encryption and SDP #223

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

Merged
merged 4 commits into from
Jul 15, 2025

Conversation

mickel8
Copy link
Member

@mickel8 mickel8 commented Jul 7, 2025

Add notes from our the first two internal WebRTC discussions. These include:

  • encryption in WebRTC - SRTP, DTLS
  • debugging in WebRTC - types of problems, debugging in production, MOS
  • SDP - general information, rules, etc.

Copy link

codecov bot commented Jul 7, 2025

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 87.82%. Comparing base (38e05e2) to head (944c4cf).
Report is 1 commits behind head on master.

Additional details and impacted files
@@            Coverage Diff             @@
##           master     #223      +/-   ##
==========================================
+ Coverage   87.79%   87.82%   +0.03%     
==========================================
  Files          54       54              
  Lines        2752     2752              
==========================================
+ Hits         2416     2417       +1     
+ Misses        336      335       -1     

see 1 file with indirect coverage changes


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 38e05e2...944c4cf. Read the comment docs.

🚀 New features to boost your workflow:
  • ❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.

@mickel8 mickel8 force-pushed the for-developers branch 8 times, most recently from 98f2c52 to e240546 Compare July 9, 2025 15:21
@mickel8 mickel8 marked this pull request as ready for review July 9, 2025 15:21
@PiotrWodecki PiotrWodecki requested a review from Copilot July 15, 2025 11:23
Copy link

@Copilot Copilot AI left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Pull Request Overview

A concise set of developer‐focused guides is added to the documentation and registered in the project config.

  • Define and include a new for_developers_guides list in mix.exs
  • Register the “For Developers” group in extras and sidebar
  • Add three markdown guides: SDP, encryption, and debugging

Reviewed Changes

Copilot reviewed 4 out of 4 changed files in this pull request and generated 11 comments.

File Description
mix.exs Added for_developers_guides and integrated into docs config
guides/for_developers/fd_sdp.md New SDP guide covering general info, rules, and negotiation flows
guides/for_developers/fd_encryption.md New encryption guide explaining SRTP, DTLS, and key derivation
guides/for_developers/fd_debugging.md New debugging guide outlining workflow, ICE, DTLS, and QoE

PiotrWodecki and others added 2 commits July 15, 2025 13:48
Co-authored-by: Copilot <[email protected]>
Co-authored-by: Copilot <[email protected]>
@mickel8 mickel8 merged commit 2eb5b36 into master Jul 15, 2025
3 checks passed
@mickel8 mickel8 deleted the for-developers branch July 15, 2025 14:25
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.

3 participants