Skip to content

docs: Update the README in the MCs folder #482

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Closed
11 tasks done
meg-gutshall opened this issue Feb 7, 2025 · 1 comment · Fixed by #483
Closed
11 tasks done

docs: Update the README in the MCs folder #482

meg-gutshall opened this issue Feb 7, 2025 · 1 comment · Fixed by #483
Assignees
Labels
Docs Addressing VC docs

Comments

@meg-gutshall
Copy link
Contributor

meg-gutshall commented Feb 7, 2025

Is there an existing issue for this?

  • I have searched the existing issues

Context for documentation change

The MC script needs a bit of a refresh. It hasn't had an overhaul in a few years so it's about time.

  • We've shut down the Virtual Coffee merch store as it was a money pit 💸
  • The monthly newsletter link has changed
  • All stages of the Coffee Chat event should be covered in the README
    • This will enable anyone to pick up the script and successfully MC a Coffee Chat without advanced prep (but hopefully that won't ever happen)
    • Add notes for what to expect during the breakout rooms
  • Include items in the introduction instructions that we've added over time and stress that sharing is optional
    • These changes should be reflected in the Room Leader and Notetaker READMEs
  • Give clearer instructions on what information is needed from a first time attendee
    • These changes should be reflected in the Room Leader and Notetaker READMEs
  • Swap newsletter link in closing announcements for website events link, as the newsletter is often incorrect
  • Add reference to #questions-about-vc Slack channel and LinkedIn page
  • Remove additional references to newsletter and podcast since that's covered in the block of links

Proposed solution

  • Remove all references and links pointing to the store
  • Change newsletter to correct link
  • Add LinkedIn reference
  • Add reference to #questions-about-vc Slack channel
  • Make section header names more detailed
  • Rewrite portions that are confusing or too wordy
  • Fix grammar and typos
  • Use GFM features
  • Lint markdown

Resources that can help

No response

Collaborators

No response

Code of Conduct

  • I've read the Code of Conduct and understand my responsibilities as a member of the Virtual Coffee community
@meg-gutshall meg-gutshall added the Docs Addressing VC docs label Feb 7, 2025
@meg-gutshall meg-gutshall self-assigned this Feb 7, 2025
@adiati98
Copy link
Contributor

adiati98 commented Feb 7, 2025

@meg-gutshall I don't think VC docs has any link to the store. Do you mean to create an issue at the vcio repo?

@meg-gutshall meg-gutshall linked a pull request Feb 8, 2025 that will close this issue
@meg-gutshall meg-gutshall changed the title docs: Remove References to VC Store docs: Update the README in the MCs folder Mar 20, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Docs Addressing VC docs
Projects
None yet
Development

Successfully merging a pull request may close this issue.

2 participants