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

Improve transport documentation #17

Closed
2 tasks done
yusefnapora opened this issue Mar 5, 2019 · 2 comments
Closed
2 tasks done

Improve transport documentation #17

yusefnapora opened this issue Mar 5, 2019 · 2 comments
Assignees
Labels
area:transports Content on transmission and transports P1 High

Comments

@yusefnapora
Copy link
Contributor

yusefnapora commented Mar 5, 2019

Done Criteria

Transports to add:

Additional improvements:

  • Interaction diagrams for dial / listen flow
  • Details about switch / swarm & how the dialer works in practice
  • Examples of different multiaddrs for various transports

Context

We have a basic concept doc for transports, but there's opportunity to improve on the content and fill in the gap of missing transport documentation.

Notes

See note from recent docs triage.

@yusefnapora yusefnapora changed the title Write concept article for transport Improve concept article for transport Mar 18, 2019
@p-shahi
Copy link
Member

p-shahi commented Aug 26, 2022

Transport section should mention Quic and WebSockets (later on WebRTC as well.) Setting this as P1 mainly for Quic docs

@p-shahi p-shahi added the P1 High label Aug 26, 2022
@salmad3 salmad3 self-assigned this Aug 29, 2022
@salmad3 salmad3 changed the title Improve concept article for transport Improve transport documentation Sep 9, 2022
@salmad3 salmad3 added the area:transports Content on transmission and transports label Sep 9, 2022
@salmad3
Copy link
Member

salmad3 commented Oct 19, 2022

Interaction diagrams to be covered in #206, switch is part of #33 & #202, and examples of different multiaddrs added for QUIC and WebTransport when we added content, which we'll follow for other transports that are added (such as WebRTC eventually). Closing this in favor of opening follow up (targeted) issues for the transport documentation to add on new transports or improve on the content.

@salmad3 salmad3 closed this as completed Oct 19, 2022
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
area:transports Content on transmission and transports P1 High
Projects
Archived in project
Status: Done
Development

No branches or pull requests

3 participants