search

w3c / openscreenprotocol

Open Screen Protocol
https://www.w3.org/TR/openscreenprotocol/
Other
93 stars 22 forks source link

Add entire flow chart. #329

Closed wangw-1991 closed 7 months ago

wangw-1991 commented 7 months ago

Add an entire flow chart to make the entire process clearer.

Preview | Diff

wangw-1991 commented 7 months ago

Hi, @mfoltzgoogle. Can you help review this? Thanks.

anssiko commented 7 months ago

@wangw-1991 thank you for this great contribution!

My expectation is this diagram is aligned with the normative text in the specification and is considered non-normative similarly to examples and notes given it is an appendix and a diagram. PTAL @mfoltzgoogle for alignment with the normative text in the specification.

@tidoust please let us know if we should explicitly mark this as non-normative.

@backkem FYI

wangw-1991 commented 7 months ago

My expectation is this diagram is aligned with the normative text in the specification and is considered non-normative similarly to examples and notes given it is an appendix and a diagram. PTAL @mfoltzgoogle for alignment with the normative text in the specification.

Acutally, I first send this entire flow chart to @mfoltzgoogle to comfirm the whole process. Mark think this is great and suggest me to add it in the spec. Please take a look again, Mark.

chrisn commented 7 months ago

This looks really good! It would be nice to see diagrams to show the metadata and application message exchanges too, as a suggestion.

wangw-1991 commented 7 months ago

This looks really good! It would be nice to see diagrams to show the metadata and application message exchanges too, as a suggestion.

Thanks for the suggestion. I don't show the metadata and application message exchanges here because there are many different types of metadata and application data. The use of abstract representation here means it is applicable to all types and it can also simplify the chart. Do you think it is reasonable?

chrisn commented 7 months ago

I think this diagram is really good as is, so no suggestion to change it. Additional diagrams, if we make them, could be specific to different use cases or scenarios, e.g., establishing a streaming session.

markafoltz commented 7 months ago

LGTM with Francois' suggestions applied. Thank you again for this contribution!