Example / documentation Initiative

[sheplu]

We did discuss a lot about documentation lately but not really on the examples sides. We currently provide a really technical documentation which is helping people if they know what they look for

But we do not provide an easy way for people to quickly see what Node.js is capable of nor how to use it in real use case - except in this repository which is a bit empty / abandonned https://github.com/nodejs/examples

I think this is a great idea to compile and slowly improve example and common use case of Node.js that would also help us and the community

@bnb tagging you as you are the most active on the repository (and we discussed a bit of it during openjs in Austin)

[sheplu]

Following the previous discussion and how/what kind of examples could be added to the new "learn" pages

• testing without lib: node:test and all thing linked
• Node-API: maybe reuse some example for the node-addons-api repository
• module CJS/ESM: how to write a lib working with both (with/without TypeScript)
• stream: Low level interaction with streams

This is a first set of ideas for topics not well covered yet - I would be keen to work on some of them

[AugustinMauroy]

How about adding a section on HTTP and web servers? That is to say an explanation for sending data (with an example using fs and streams) and a contact form without lib.

[bnb]

I apparently missed the original tag here. I'm potentially interested in engaging here - I've been taking a bit of a break because of how I was treated in the project, but I'm more comfortable now coming back and poking at some things.

[bnb]

apologies on the delay on this, have been busy with work/travel.

I'm +1 to reworking/continuing to improve nodejs/examples. I think in general the idea behind how it's currently set up should be retained (have a wide variety of examples that are allowed, allow platform-specific examples even if those platforms are paid), but agree it needs love. I think generally it just needs people to write examples. I explicitly didn't write examples because I didn't want it to be yet another thing that only I was driving, which has been A Thing in the past. I'd very much love it if other people were interested and wanted to take charge - I'd also be happy to be a contributor of examples.

Some notes on what I think could help dramatically improve its current state:

• use npm workspaces to be able to run all tests at once and allow more granular test running
• fix CI to actually scope them correctly (paths works! this is what stopped me from working on it more!)
• do outreach to other projects to try to partner with them to get some examples in

[sheplu]

I could delegate some time to take charge on this repository and work with you to see the direction we want it to go. I will agree with what you said, should not be a one people work but allow contribution and participation from everyone.

I think this is something that could also be reused as another "doc" by the website and or articles.

If you have some time to do a quick call (or during a next-10 meeting) we could align on that :)

[sheplu]

ping @bnb ?

[PatrickHeneise]

I'd like to get involved with examples and showcases / success stories.

[sheplu]

I will be opening an issue with some ideas inside the example repo https://github.com/nodejs/examples so we can start brainstorming :)

[sheplu]

@PatrickHeneise opened a first issue with some ideas, adding the link here to maybe discuss about it during the next-10 meeting https://github.com/nodejs/examples/issues/43 . do not hesitate to add some more ideas

[PatrickHeneise]

Great, thanks! Any ideas/preferences on how the examples should be structured?

[mhdawson]

Access has been fasciliated, rest of work will be done in the examples repo itself. @sheplu indicated we should close.