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

Created a document with internals description #1299

Draft
wants to merge 1 commit into
base: master
Choose a base branch
from

Conversation

ethouris
Copy link
Collaborator

No description provided.

@ethouris ethouris added Type: Enhancement Indicates new feature requests [docs] Area: Improvements or additions to documentation Impact: High labels May 22, 2020
@ethouris ethouris self-assigned this May 22, 2020
@maxsharabayko
Copy link
Collaborator

Good initiative.
We should however avoid duplicated descriptions in separate places.
There are these resources besides SRT docs:

Some protocol related description is better to go to SRT RFC.
SRT Cookbook should contain some elaborated description of certain algorithms.

@ethouris Do you think there is something that can be moved to RFC?

@ethouris
Copy link
Collaborator Author

The intention of these documents is to describe the internals of the implementation. The RFC in my opinion should describe the protocol, regardless of the implementation. So I wouldn't see any common parts here, although some of this description can be borrowed in order to define what exactly the implementation is expected to do in particular situation.

@ethouris ethouris marked this pull request as draft May 27, 2020 08:14
@mbakholdina mbakholdina added this to the Parking Lot milestone Oct 22, 2020
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
[docs] Area: Improvements or additions to documentation Type: Enhancement Indicates new feature requests
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants