openjs-foundation / summit

Organizing a Collaborator Summit
136 stars 57 forks source link

Session Proposal: Documentation Improvements #403

Open Qard opened 3 months ago

Qard commented 3 months ago

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

Estimated duration of the session

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

Date and Time of the session

Level

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 commented 3 months ago

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 commented 3 months ago

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 commented 2 months ago

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

Qard commented 2 months ago

Sounds reasonable to me. 👍🏻