adding docs for WebTransport

[chrisdavidmills]

Description

This PR provides docs for the WebTransport API data. You can see more details about my work in my research document

Review status: awaiting tech review from a Chromium SME.

A couple of notes:

1. I'm not really sure about my example on the WebTransportError pages. I thought my example would return a WebTransportError, but error.source and error.streamErrorCode return undefined.
2. I'm still not quite sure if the chunks transmitted by the WebTransport.incomingUnidirectionalStreams ReadableStream are of type WebTransportReceiveStream, or whether these are just ReadableStreams for now. It doesn't matter hugely for the examples given, as the effect is the same either way, but it is hard to test, and it'd be good to get this right.

Motivation

High profile new API for developers to learn about.

Additional details

Related issues and pull requests

Fixes #22281

[github-actions]

Preview URLs (26 pages)

• /en-US/docs/Web/API/WebTransport/WebTransport
• /en-US/docs/Web/API/WebTransport/close
• /en-US/docs/Web/API/WebTransport/closed
• /en-US/docs/Web/API/WebTransport/createBidirectionalStream
• /en-US/docs/Web/API/WebTransport/createUnidirectionalStream
• /en-US/docs/Web/API/WebTransport/datagrams
• /en-US/docs/Web/API/WebTransport/incomingBidirectionalStreams
• /en-US/docs/Web/API/WebTransport/incomingUnidirectionalStreams
• /en-US/docs/Web/API/WebTransport/ready
• /en-US/docs/Web/API/WebTransportBidirectionalStream/readable
• /en-US/docs/Web/API/WebTransportBidirectionalStream/writable
• /en-US/docs/Web/API/WebTransportBidirectionalStream
• /en-US/docs/Web/API/WebTransportDatagramDuplexStream/incomingHighWaterMark
• /en-US/docs/Web/API/WebTransportDatagramDuplexStream/incomingMaxAge
• /en-US/docs/Web/API/WebTransportDatagramDuplexStream/maxDatagramSize
• /en-US/docs/Web/API/WebTransportDatagramDuplexStream/outgoingHighWaterMark
• /en-US/docs/Web/API/WebTransportDatagramDuplexStream/outgoingMaxAge
• /en-US/docs/Web/API/WebTransportDatagramDuplexStream/readable
• /en-US/docs/Web/API/WebTransportDatagramDuplexStream/writable
• /en-US/docs/Web/API/WebTransportDatagramDuplexStream
• /en-US/docs/Web/API/WebTransportError/WebTransportError
• /en-US/docs/Web/API/WebTransportError/source
• /en-US/docs/Web/API/WebTransportError/streamErrorCode
• /en-US/docs/Web/API/WebTransportError
• /en-US/docs/Web/API/WebTransport
• /en-US/docs/Web/API/WebTransport_API

Flaws (4)

Note! 24 documents with no flaws that don't need to be listed. 🎉

URL: /en-US/docs/Web/API/WebTransport
Title: WebTransport
Flaw count: 1

• macros:
  • /en-US/docs/Web/API/WebTransportReceiveStream does not exist

---

URL: /en-US/docs/Web/API/WebTransport/incomingUnidirectionalStreams
Title: WebTransport.incomingUnidirectionalStreams
Flaw count: 3

• macros:
  • /en-US/docs/Web/API/WebTransportReceiveStream does not exist
  • /en-US/docs/Web/API/WebTransportReceiveStream does not exist
  • /en-US/docs/Web/API/WebTransportReceiveStream does not exist

External URLs (55)

URL: /en-US/docs/Web/API/WebTransportError
Title: WebTransportError

• https://datatracker.ietf.org/doc/html/draft-ietf-webtrans-http3/ (1 time) (Note! This may be a new URL 👀)
• https://web.dev/webtransport/ (1 time) (Note! This may be a new URL 👀)

---

URL: /en-US/docs/Web/API/WebTransportError/WebTransportError
Title: WebTransportError()

• https://datatracker.ietf.org/doc/html/draft-ietf-webtrans-http3/ (1 time) (Note! This may be a new URL 👀)
• https://web.dev/webtransport/ (1 time) (Note! This may be a new URL 👀)

---

URL: /en-US/docs/Web/API/WebTransportError/streamErrorCode
Title: WebTransportError.streamErrorCode

• https://datatracker.ietf.org/doc/html/draft-ietf-webtrans-http3/ (1 time) (Note! This may be a new URL 👀)
• https://web.dev/webtransport/ (1 time) (Note! This may be a new URL 👀)

---

URL: /en-US/docs/Web/API/WebTransportError/source
Title: WebTransportError.source

• https://datatracker.ietf.org/doc/html/draft-ietf-webtrans-http3/ (1 time) (Note! This may be a new URL 👀)
• https://web.dev/webtransport/ (1 time) (Note! This may be a new URL 👀)

---

URL: /en-US/docs/Web/API/WebTransport_API
Title: WebTransport API

• https://datatracker.ietf.org/doc/html/draft-ietf-webtrans-http3/ (2 times) (Note! This may be a new URL 👀)
• https://en.wikipedia.org/wiki/HTTP/3 (1 time) (Note! This may be a new URL 👀)
• https://web.dev/webtransport/ (1 time) (Note! This may be a new URL 👀)
• https://webrtc.internaut.com/wc/wtSender4/ (1 time) (Note! This may be a new URL 👀)
• https://webtransport.day/ (1 time) (Note! This may be a new URL 👀)

---

URL: /en-US/docs/Web/API/WebTransportBidirectionalStream
Title: WebTransportBidirectionalStream

• https://datatracker.ietf.org/doc/html/draft-ietf-webtrans-http3/ (1 time) (Note! This may be a new URL 👀)
• https://web.dev/webtransport/ (1 time) (Note! This may be a new URL 👀)

---

URL: /en-US/docs/Web/API/WebTransportBidirectionalStream/writable
Title: WebTransportBidirectionalStream.writable

• https://datatracker.ietf.org/doc/html/draft-ietf-webtrans-http3/ (1 time) (Note! This may be a new URL 👀)
• https://web.dev/webtransport/ (1 time) (Note! This may be a new URL 👀)

---

URL: /en-US/docs/Web/API/WebTransportBidirectionalStream/readable
Title: WebTransportBidirectionalStream.readable

• https://datatracker.ietf.org/doc/html/draft-ietf-webtrans-http3/ (1 time) (Note! This may be a new URL 👀)
• https://web.dev/webtransport/ (1 time) (Note! This may be a new URL 👀)

---

URL: /en-US/docs/Web/API/WebTransportDatagramDuplexStream
Title: WebTransportDatagramDuplexStream

• https://datatracker.ietf.org/doc/html/draft-ietf-webtrans-http3/ (1 time) (Note! This may be a new URL 👀)
• https://web.dev/webtransport/ (1 time) (Note! This may be a new URL 👀)

---

URL: /en-US/docs/Web/API/WebTransportDatagramDuplexStream/outgoingHighWaterMark
Title: WebTransportDatagramDuplexStream.outgoingHighWaterMark

• https://datatracker.ietf.org/doc/html/draft-ietf-webtrans-http3/ (1 time) (Note! This may be a new URL 👀)
• https://web.dev/webtransport/ (1 time) (Note! This may be a new URL 👀)

---

URL: /en-US/docs/Web/API/WebTransportDatagramDuplexStream/incomingHighWaterMark
Title: WebTransportDatagramDuplexStream.incomingHighWaterMark

• https://datatracker.ietf.org/doc/html/draft-ietf-webtrans-http3/ (1 time) (Note! This may be a new URL 👀)
• https://web.dev/webtransport/ (1 time) (Note! This may be a new URL 👀)

---

URL: /en-US/docs/Web/API/WebTransportDatagramDuplexStream/maxDatagramSize
Title: WebTransportDatagramDuplexStream.maxDatagramSize

• https://datatracker.ietf.org/doc/html/draft-ietf-webtrans-http3/ (1 time) (Note! This may be a new URL 👀)
• https://web.dev/webtransport/ (1 time) (Note! This may be a new URL 👀)

---

URL: /en-US/docs/Web/API/WebTransportDatagramDuplexStream/outgoingMaxAge
Title: WebTransportDatagramDuplexStream.outgoingMaxAge

• https://datatracker.ietf.org/doc/html/draft-ietf-webtrans-http3/ (1 time) (Note! This may be a new URL 👀)
• https://web.dev/webtransport/ (1 time) (Note! This may be a new URL 👀)

---

URL: /en-US/docs/Web/API/WebTransportDatagramDuplexStream/writable
Title: WebTransportDatagramDuplexStream.writable

• https://datatracker.ietf.org/doc/html/draft-ietf-webtrans-http3/ (1 time) (Note! This may be a new URL 👀)
• https://web.dev/webtransport/ (1 time) (Note! This may be a new URL 👀)

---

URL: /en-US/docs/Web/API/WebTransportDatagramDuplexStream/incomingMaxAge
Title: WebTransportDatagramDuplexStream.incomingMaxAge

• https://datatracker.ietf.org/doc/html/draft-ietf-webtrans-http3/ (1 time) (Note! This may be a new URL 👀)
• https://web.dev/webtransport/ (1 time) (Note! This may be a new URL 👀)

---

URL: /en-US/docs/Web/API/WebTransportDatagramDuplexStream/readable
Title: WebTransportDatagramDuplexStream.readable

• https://datatracker.ietf.org/doc/html/draft-ietf-webtrans-http3/ (1 time) (Note! This may be a new URL 👀)
• https://web.dev/webtransport/ (1 time) (Note! This may be a new URL 👀)

---

URL: /en-US/docs/Web/API/WebTransport
Title: WebTransport

• https://datatracker.ietf.org/doc/html/draft-ietf-webtrans-http3/ (1 time) (Note! This may be a new URL 👀)
• https://web.dev/webtransport/ (1 time) (Note! This may be a new URL 👀)

---

URL: /en-US/docs/Web/API/WebTransport/incomingUnidirectionalStreams
Title: WebTransport.incomingUnidirectionalStreams

• https://datatracker.ietf.org/doc/html/draft-ietf-webtrans-http3/ (1 time) (Note! This may be a new URL 👀)
• https://web.dev/webtransport/ (1 time) (Note! This may be a new URL 👀)

---

URL: /en-US/docs/Web/API/WebTransport/createBidirectionalStream
Title: WebTransport.createBidirectionalStream()

• https://datatracker.ietf.org/doc/html/draft-ietf-webtrans-http3/ (1 time) (Note! This may be a new URL 👀)
• https://web.dev/webtransport/ (1 time) (Note! This may be a new URL 👀)

---

URL: /en-US/docs/Web/API/WebTransport/createUnidirectionalStream
Title: WebTransport.createUnidirectionalStream()

• https://datatracker.ietf.org/doc/html/draft-ietf-webtrans-http3/ (1 time) (Note! This may be a new URL 👀)
• https://web.dev/webtransport/ (1 time) (Note! This may be a new URL 👀)

---

URL: /en-US/docs/Web/API/WebTransport/ready
Title: WebTransport.ready

• https://datatracker.ietf.org/doc/html/draft-ietf-webtrans-http3/ (1 time) (Note! This may be a new URL 👀)
• https://web.dev/webtransport/ (1 time) (Note! This may be a new URL 👀)

---

URL: /en-US/docs/Web/API/WebTransport/close
Title: WebTransport.close()

• https://datatracker.ietf.org/doc/html/draft-ietf-webtrans-http3/ (1 time) (Note! This may be a new URL 👀)
• https://web.dev/webtransport/ (1 time) (Note! This may be a new URL 👀)

---

URL: /en-US/docs/Web/API/WebTransport/closed
Title: WebTransport.closed

• https://datatracker.ietf.org/doc/html/draft-ietf-webtrans-http3/ (1 time) (Note! This may be a new URL 👀)
• https://web.dev/webtransport/ (1 time) (Note! This may be a new URL 👀)

---

URL: /en-US/docs/Web/API/WebTransport/datagrams
Title: WebTransport.datagrams

• https://datatracker.ietf.org/doc/html/draft-ietf-webtrans-http3/ (1 time) (Note! This may be a new URL 👀)
• https://web.dev/webtransport/ (1 time) (Note! This may be a new URL 👀)

---

URL: /en-US/docs/Web/API/WebTransport/WebTransport
Title: WebTransport()

• https://datatracker.ietf.org/doc/html/draft-ietf-webtrans-http3/ (1 time) (Note! This may be a new URL 👀)
• https://web.dev/webtransport/ (1 time) (Note! This may be a new URL 👀)

---

URL: /en-US/docs/Web/API/WebTransport/incomingBidirectionalStreams
Title: WebTransport.incomingBidirectionalStreams

• https://datatracker.ietf.org/doc/html/draft-ietf-webtrans-http3/ (1 time) (Note! This may be a new URL 👀)
• https://web.dev/webtransport/ (1 time) (Note! This may be a new URL 👀)

(comment last updated: 2022-12-19 08:50:45)

[sideshowbarker]

I’ll take a look at this now

[chrisdavidmills]

Thanks for the suggestions @sideshowbarker ; committed!

I also made some code updates in response to some comments the spec author gave me over email. I'll see if I can get a more thorough SME review at some point; do you think this is ready to be published?

[sideshowbarker]

Thanks for the suggestions @sideshowbarker ; committed!

👍

I also made some code updates in response to some comments the spec author gave me over email. I'll see if I can get a more thorough SME review at some point; do you think this is ready to be published?

It’s up to you, but I would vote for going ahead and merging this now.

I think this is of sufficient quality that we should get it out to developers to read and use now rather than waiting.

You could get more review post-commit — and you could (if you wanted to) ask SMEs to review the actual published articles on the production site, and submit pull requests with suggested changes. Personally I find that can be a productive way to get detailed review, and get fixes and refinements made efficiently.

If you did that, having an SME start with review of the https://developer.mozilla.org/en-US/docs/Web/API/WebTransport_API article would seem like a good way to give it a try.

But again it’s up to you — I’m happy to go ahead and push the merge button on this now, but also happy to wait if you want to get more review of it before we land it

[chrisdavidmills]

But again it’s up to you — I’m happy to go ahead and push the merge button on this now, but also happy to wait if you want to get more review of it before we land it

@sideshowbarker go ahead and merge it. I agree with your reasoning here, and I just got approval from the Chrome team to do so, too. Thanks!