[WIP] doc: better stream docs #19143
Conversation
Adding new section headers for stream docs.
nodejs-github-bot
added
doc
|
One nit: |
|
Suggestion: Add a section early on explaining why streams are such an important concept in Node. The current document takes this for granted in the front matter, but given that this is quite a long document I think we might as well be near-pedantic about it. |
| additional notes. The first section explains the elements of the stream API that | ||
| are required to *use* streams within an application. The second section explains | ||
| the elements of the API that are required to *implement* new types of streams. | ||
| The third section is geared towards explanations and *code examples*. The fourth | ||
| section showcases important *npm modules* that make working with streams |
There was a problem hiding this comment.
I'm not sure we really want to implement a section like that to be honest. In the past, we've avoided the appearance of promoting certain modules over their competitors. We'd want to be very careful about that.
There was a problem hiding this comment.
Sounds good! I can get rid of the specific section and maybe instead have examples that use those modules?
| additional notes. The first section explains the elements of the stream API that | ||
| are required to *use* streams within an application. The second section explains | ||
| the elements of the API that are required to *implement* new types of streams. | ||
| The third section is geared towards explanations and *code examples*. The fourth |
There was a problem hiding this comment.
Nit: "geared towards explanations" is less informative than this should be IMO. Maybe this?
The third section explains <whatever it is supposed to explain> including code samples.Or perhaps even better, this?
The third section contains code samples.There was a problem hiding this comment.
Sounds good! Will update
|
@nodejs/documentation @nodejs/streams |
|
I think this should better live in a guide in the website. |
|
@mcollina Should I move this to https://github.com/nodejs/nodejs.org? perhaps one of the guides? |
|
@wuweiweiwu I think so, yes. |
|
@mcollina Sounds good! Ill close this and open a PR in nodejs.org repo |
Adding better and more user friendly stream docs as per #8646
duplexifyend-of-streamconcat-streamflush-write-streamfrom2parallel-transformpumppumpifystream-eachthrough2Any suggestions / feedback is extremely welcomed :) I'm definitely missing some npm modules.
Checklist
make -j4 test(UNIX), orvcbuild test(Windows) passesAffected core subsystem(s)
doc