whatwg / streams

Streams Standard
https://streams.spec.whatwg.org/
Other
1.34k stars 157 forks source link

Request review MDN readable byte streams docs #1237

Closed hamishwillee closed 1 year ago

hamishwillee commented 2 years ago

MDN documentation for readable byte streams has been added in https://github.com/mdn/content/pull/16818

@mgaudet Plans to review this next week but recommended I request your review too.

I appreciate you're busy people. To limit the scope, the most valuable thing you could do would be look at the guide overview: https://pr16818.content.dev.mdn.mozit.cloud/en-US/docs/Web/API/Streams_API/Using_readable_byte_streams

This provides an overview of how the API works and a number of examples that draw heavily on the file and "socket" examples from the spec (essentially it provides a mock file/socket making it easier to see the code running in action). Everything else makes the same assumptions - so anything "wrong" will be reflected in the interface docs.