EricssonResearch / EricssonResearch/openwebrtc

Needs basic overview documentation

Open
#63 2 comments 0 reactions 0 assignees View on GitHub
All Platforms enhancement Non-Build Issue
Dominant language
C
Stars
1.8k
Forks
531
PR merge metrics
No merged PRs in 30d

Description

The documentation / readme doesn't say much
- What type of container is the javascript running in?
- What does the media bridge do?
- How is the code organized? What is in the different directories?
- What features are different/missing compared to FF, Chromium, Chrome?
- Is the architecture diagram relevant for Android & iOS?
- What are the main features?

A few lines added to the front page would go a long way.

Contributor guide

Open the contributing guide

Research direction

Start with the documentation/README front page and review the existing architecture diagram and directory descriptions. Add a concise overview addressing the JavaScript container, media bridge, code organization, browser differences, Android and iOS relevance, and main features; done means these questions are answered on the front page.

Written by the indexing model from the issue text.

Assessment

Tech stack
android, ios, javascript
Domain
documentation
Issue type
Documentation
Difficulty
2/5
Estimated time
1-3 hours
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
35/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.