Virtual-Coffee / VC-Community-Docs

Management and coordination for Virtual Coffee events
https://virtualcoffee.io/
Other
18 stars 3 forks source link

docs: Improve Monthly Challenge Team Documentation #324

Open adiati98 opened 1 year ago

adiati98 commented 1 year ago

Motivation

As our monthly challenges are evolving, we need to update our documentation for the Monthly Challenge Team to accomodate the changes. It will be very helpful for new volunteers to onboard themselves when we have updated documentation.

Suggestions

Let's gradually improving the docs for Monthly Challenge Team as we go and when we know the structure for every challenge.

We can update the docs we have now (and rename the files accordingly). Or we can create a new file for each challenge, and archive the old one in a folder once the challenge is updated.

To Do

General Docs

Update VC Challenges (in no particular order)

Contents for every challenge

Every monthly challenge will have following contents:

adiati98 commented 1 year ago

@danieltott @BekahHW, Me and/or @dominicduffin1 will update our monthly challenge documentation gradually.

Any thoughts on this?

I have examples of a PR and two draft PRs here.

danieltott commented 1 year ago

I think this is fine. If there is any specific stuff we did in previous years that we're not doing any more, it'd be good to archive that. But in general this all sounds good 👍🏼

danieltott commented 1 year ago

The other change I would make is make all of the facilitators-guide.md files README.md files so that they just show up when you land on the directory.