Skip to content
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

Update the README in the MCs folder #483

Merged
merged 8 commits into from
Mar 22, 2025

Conversation

meg-gutshall
Copy link
Contributor

Linked Issue

Closes #482

Description

I removed the store link from the block the MC pastes in the Zoom chat.

I also cleaned the script up a bit.

Code of Conduct

By submitting this pull request, you agree to follow our Code of Conduct

@meg-gutshall meg-gutshall added the Docs Addressing VC docs label Feb 8, 2025
@meg-gutshall meg-gutshall self-assigned this Feb 8, 2025
@meg-gutshall meg-gutshall requested a review from a team as a code owner February 8, 2025 00:04
@meg-gutshall meg-gutshall linked an issue Feb 8, 2025 that may be closed by this pull request
11 tasks
@meg-gutshall meg-gutshall requested a review from adiati98 February 8, 2025 00:05
Copy link
Contributor

@adiati98 adiati98 left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Hey, @meg-gutshall,

Now I see what you mean by removing references to VC store. It wasn't clear on the issue. 😅

However, this PR is out of the scope from what has been proposed.

Can you please either:

  • Remove the changes besides removing the references and create another issue & PR for updating the content, or
  • Update your issue to "Update the README in the MCs folder", and mention the reasons of the update and the proposed solutions in the body

This will be benefit us to have a clear history of the changes in this repo. Thanks! ✨

Copy link

netlify bot commented Mar 20, 2025

Deploy Preview for vc-community-docs ready!

Name Link
🔨 Latest commit e0226ee
🔍 Latest deploy log https://app.netlify.com/sites/vc-community-docs/deploys/67df246dd71cfc00086b7dd9
😎 Deploy Preview https://deploy-preview-483--vc-community-docs.netlify.app
📱 Preview on mobile
Toggle QR Code...

QR Code

Use your smartphone camera to open QR code link.

To edit notification comments on pull requests, go to your Netlify site configuration.

@github-actions github-actions bot requested a review from a team as a code owner March 20, 2025 17:40
@meg-gutshall meg-gutshall changed the title Remove References to VC Store Update the README in the MCs folder Mar 20, 2025
@meg-gutshall
Copy link
Contributor Author

Hey @adiati98! I implemented the changes you requested by updating the issue.

It looks like when I pulled in the changes, my IDE auto-formatted all the Docusaurus front matter. I'm gonna have to figure out how to get around that...

@danieltott, any ideas?

@BekahHW
Copy link
Member

BekahHW commented Mar 20, 2025

@meg-gutshall so it looks like the issue is that it reformatted the frontmatter to single quotes.

You might have to change a setting in your VSCode if that's what you're using:Open Settings (Ctrl+Shift+P → Preferences: Open Settings (JSON))

{
  "[markdown]": {
    "editor.formatOnSave": false
  }
}

But also, I don't necessarily disagree with this change. We should probably make everything consistent with single quotes.

@danieltott
Copy link
Member

I don't believe that it was your IDE - pretty sure it was the prettier workflow - see this commit: 5b4b5ba

Assuming you're using VS code - any auto-formatting should be following the guidelines in the prettier settings.

The real question is why wasn't this code already auto-formatted?

@BekahHW
Copy link
Member

BekahHW commented Mar 20, 2025

@danieltott it's definitely my bad. I merged in that PR to move everything to docusaurus, and I didn't realize that.

@meg-gutshall
Copy link
Contributor Author

Or it was ghosts... 👻

@meg-gutshall
Copy link
Contributor Author

Okay, that is really weird though. If you look at Ayu's PR, you'll see that there was a prettier workflow commit on hers as well! Then Bekah made a commit, prettier ran again, and she merged it. It doesn't make sense why that first prettier commit wasn't there anymore.

cc: @danieltott @BekahHW @adiati98

@danieltott danieltott force-pushed the 482-docs-remove-references-to-vc-store branch from 7378794 to 3296ea9 Compare March 20, 2025 20:11
@danieltott
Copy link
Member

OK - I fixed up the branch to only contain changes to that one file. I didn't asses the content changes though so won't approve just based on that

@meg-gutshall
Copy link
Contributor Author

meg-gutshall commented Mar 20, 2025

OK - I fixed up the branch to only contain changes to that one file. I didn't asses the content changes though so won't approve just based on that

Thank youuuuu! 😍

Can you revert that markdown change though? It's an email autolink. Don't TEST me on my markdown!

@danieltott
Copy link
Member

It was breaking the docusaurus build ¯_(ツ)_/¯

BekahHW
BekahHW previously approved these changes Mar 20, 2025
@meg-gutshall meg-gutshall requested a review from adiati98 March 20, 2025 22:33
adiati98
adiati98 previously approved these changes Mar 21, 2025
Copy link
Contributor

@adiati98 adiati98 left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Hey @meg-gutshall,

There are a couple things that need to be fixed here before merging in.
Other than these, it's good to go! 🚀

I'm approving to save time. 👍🏼

Comment on lines 60 to 61
> [!NOTE]
> While the welcome is happening, the Zoom host of the day creates the breakout rooms. Signal to the host to open the rooms once you've finished reading the welcome announcements.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

issue: This syntax is to add admonition in GitHub. But Docusaurus has different syntax.

Suggested change
> [!NOTE]
> While the welcome is happening, the Zoom host of the day creates the breakout rooms. Signal to the host to open the rooms once you've finished reading the welcome announcements.
:::note
While the welcome is happening, the Zoom host of the day creates the breakout rooms. Signal to the host to open the rooms once you've finished reading the welcome announcements.
:::

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks for the helpful documentation link! Now that I'm looking at it, this should probably be INFO instead of NOTE.

Comment on lines 105 to 106
> [!NOTE]
> Details for these announcements can be found on the [website's events calendar](https://virtualcoffee.io/events).
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
> [!NOTE]
> Details for these announcements can be found on the [website's events calendar](https://virtualcoffee.io/events).
:::note
Details for these announcements can be found on the [website's events calendar](https://virtualcoffee.io/events).
:::

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

And this one TIP instead of NOTE.

@meg-gutshall meg-gutshall dismissed stale reviews from adiati98 and BekahHW via e0226ee March 22, 2025 20:58
@meg-gutshall meg-gutshall merged commit 6276355 into main Mar 22, 2025
5 checks passed
@meg-gutshall meg-gutshall deleted the 482-docs-remove-references-to-vc-store branch March 22, 2025 21:36
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 this pull request may close these issues.

docs: Update the README in the MCs folder
4 participants