microsoftgraph / microsoftgraph/microsoft-graph-comms-samples

Application Hosted Media Calls Documentation insufficient

Open
#265 1 comment 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Dominant language
No language data
Stars
253
Forks
275
Avg merge
1d 5h
Merged PRs (30d)
1

Description

Describe the issue
The documentation about initiating an Application Hosted Media Call is insufficient.

  • The instructions to build a communications client are not usable:
  • Step 1 states to create an instance of an interface instead of listing the concrete class or classes that can be instantiated,
  • Step 2 is very difficult to understand and could be made much clearer with one or two lines of code.
  • Most of the class reference links on the page are broken

Code Snippet
A minimal code sample about how to initiate a call using the Graph Communications SDK should be present.

Contributor guide

No contributing guide indexed for this repository

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Start with the Application Hosted Media Call article linked in the issue and review its communications-client build instructions, class-reference links, and the Graph Communications SDK terminology. Done means the steps identify instantiable concrete classes, clarify Step 2 with one or two code lines, repair the broken links, and include a minimal call-initiation sample.

Written by the indexing model from the issue text.

Assessment

Domain
documentation
Issue type
Documentation
Difficulty
3/5
Estimated time
1-2 days
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
35/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.