Session Proposal: Documentation Improvements

[Qard]

Proposal

With the new website now launched, there's a new doc structure and some great new docs in there. A few sections are a bit light on content though so it might be worth a conversation about what new content we want to add to improve those sections.

Topic of the session

Space to discuss improving documentation on newly designed nodejs.org website.

Type of the session

• [x] Collaborate
• [ ] Workshop
• [ ] Talk

Estimated duration of the session

1h? Maybe less? Depends on how many people have ideas.

Date and Time of the session

Level

• [x] Beginner
• [x] Intermediate
• [x] Advanced

Pre-requisite knowledge

None.

Describe the session

Ideation on areas we can improve our docs.

Session facilitator(s), Github handle(s) and timezone(s)

Stephen Belanger (@qard)

Meeting notes and Virtual Meeting Link

Follow-up / Set-up sessions (if any)

Additional context (optional)

---

[joyeecheung]

hmm, it seems a bit too late to squeeze another session in, we have a packed agenda. Would it make sense to move it to the hallway track? (We have scheduled 1h45m for lunch. There should be plenty of room for more casual discussions).

EDIT: on a second thought, we may not need that long a lunch break. will try to see if we can squeeze a slot from it.

[Qard]

Hallway track is fine if space is not available. Just wanted to prompt folks to be thinking about docs improvements now that we've got the better website structure for it and to hopefully come up with some ideas on what we could add or expand. I don't think that would be a long discussion. 😅

[joyeecheung]

Should this remain open? Sounds like a good session for the next summit.

[Qard]

Sounds reasonable to me. 👍🏻

[Ceres6]

Hey I wanted to bring this up again now that the new Dublin Summit is scheduled. I'm trying to put up streams documentation/guide and I think this could be a good opportunity to discuss it among other posible doc improvements

[JakobJingleheimer]

@Qard would you be interested in hosting this talk for the Dublin summit?

[bmuenzenmeyer]

If there isn't another slot for this yet (cc @ovflowd) it'd be a good place to talk about our https://github.com/nodejs/api-docs-tooling efforts via https://github.com/nodejs/node/issues/52343

[ovflowd]

Oh yes, that's a good point. cc @Qard wdyt?

[ovflowd]

I'm also fine co-hosting this one, if that's up :)

[Qard]

I'm up for that. Anything docs improvement related is relevant, I think.

I'll be at the collab summit, though I'm leaving Datadog so I'm not sure yet how much time I'll have to prepare for things.