Skip to content
Open
Show file tree
Hide file tree
Changes from 13 commits
Commits
Show all changes
25 commits
Select commit Hold shift + click to select a range
cc66323
docs: add mermaid diagrams part 2
CBID2 Oct 11, 2025
9a32a98
Prettified Code!
CBID2 Oct 11, 2025
f16f94d
docs: redid format
CBID2 Oct 11, 2025
07352bc
Prettified Code!
CBID2 Oct 11, 2025
21ec283
docs: fixing deployment issues
CBID2 Oct 12, 2025
603d2a0
Prettified Code!
CBID2 Oct 12, 2025
95557a1
Merge branch 'Virtual-Coffee:main' into adding-diagrams-redo
CBID2 Oct 13, 2025
feca8f2
docs: add other diagrams
CBID2 Oct 13, 2025
2ae87de
Prettified Code!
CBID2 Oct 13, 2025
aad4695
docs: change and resize diagrams
CBID2 Oct 13, 2025
1a53514
Merge branch 'Virtual-Coffee:main' into adding-diagrams-redo
CBID2 Oct 17, 2025
655f819
docs: unify Mermaid diagrams and styling
CBID2 Oct 20, 2025
6ea4bfc
Prettified Code!
CBID2 Oct 20, 2025
efef520
style: update Mermaid diagrams and section styling for consistency
CBID2 Oct 24, 2025
88b34c7
Prettified Code!
CBID2 Oct 24, 2025
53e46db
docs: add enhanced Mermaid diagrams to documentation
CBID2 Oct 24, 2025
212aae4
Prettified Code!
CBID2 Oct 24, 2025
6d8492e
Update Lunch & Learn process docs and flowchart
CBID2 Nov 1, 2025
f0e66f6
Prettified Code!
CBID2 Nov 1, 2025
b76028b
Update Lightning Talks workflow with improved Mermaid diagrams and mo…
CBID2 Nov 8, 2025
25f572b
Prettified Code!
CBID2 Nov 8, 2025
cd80ccb
Update Mermaid diagrams for better readability and mobile-friendliness
CBID2 Nov 8, 2025
9af724c
Prettified Code!
CBID2 Nov 8, 2025
1916ecc
fix: reorganize mermaid diagrams into proper sections
CBID2 Mar 28, 2026
f8d3ad4
fix: remove Post-Event section and diagram
CBID2 Mar 28, 2026
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
53 changes: 53 additions & 0 deletions docs/lightning-talks/processes/project-workflow.md
Original file line number Diff line number Diff line change
Expand Up @@ -35,6 +35,59 @@ tags:

The function of the Lightning Talks Event is to allow opportunities for members of the community to have an intimate space to present on a tech topic for 5-15 minutes. When live-streaming as a members-only event, speakers can feel more comfortable as it's _their_ community listening and watching. However, their is still opportunity to impact a larger audience once the videos have been processed and put up on YouTube.

Below is the workflow for the Lightning Talks Event.

#### Planning

```mermaid
%%{init: { "themeVariables": { "fontSize": "20px" }, "flowchart": { "nodeSpacing": 50, "rankSpacing": 60, "padding": 4 } } }%%
flowchart TB
A1[📢 Call for Team] --> A2[👥 Onboard Team]
A2 --> A3[📝 Assign Coordinators]
```

#### CFP

```mermaid
%%{init: { "themeVariables": { "fontSize": "20px" }, "flowchart": { "nodeSpacing": 50, "rankSpacing": 60, "padding": 4 } } }%%
flowchart TB
B1[📣 CFP Opens] --> B2[🧾 Collect Proposals]
B2 --> B0{Enough?}
B0 -- Yes --> B3[👩‍💻 Grouping]
B0 -- No --> B4[📣 Extend CFP]
B4 --> B2
```

#### Speaker Prep

```mermaid
%%{init: { "themeVariables": { "fontSize": "20px" }, "flowchart": { "nodeSpacing": 50, "rankSpacing": 70, "padding": 10 } } }%%
flowchart TB
C1[🗂 Organize Talks] --> C2[✅ Checklists]
C2 --> C0{Missing?}
C0 -- Yes --> C5[📬 Request Info]
C5 --> C2
C0 -- No --> C3[📸 Speaker Info]
C3 --> C4[📁 Shared Folder]
```

#### Event

```mermaid
%%{init: { "themeVariables": { "fontSize": "20px" }, "flowchart": { "nodeSpacing": 50, "rankSpacing": 70, "padding": 10 } } }%%
flowchart TB
D1[🧾 Final Prep] --> D2[📨 Directions]
D2 --> D3[🧑‍🏫 Talks]
```

#### Post-Event

```mermaid
%%{init: { "themeVariables": { "fontSize": "20px" }, "flowchart": { "nodeSpacing": 50, "rankSpacing": 70, "padding": 10 } } }%%
flowchart TB
E1[☁️ Upload to YouTube]
```

### Specifics

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

I like the way these look and how you can open and close. I would put them under the proper heading. For instance, you have all the drop downs at the top, but the CFP diagram should go in the CFP section. That helps to keep the info organized in a logical way. Otherwise the right nav for the page gets super confusing. You have the same thing 2x and you have something that says Post-Event and then CFP comes after that.

If some of those don't have their own section rn, just move them to where they'd make sense chronologically. But really like how these have turned out!

Image Image Image

Copy link
Copy Markdown
Author

Choose a reason for hiding this comment

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

Made the changes. What do you think?

image of changes to my pull request


- 5-15 minutes on one topic
Expand Down
22 changes: 20 additions & 2 deletions docs/lunch-and-learns/process-docs.md
Original file line number Diff line number Diff line change
Expand Up @@ -31,8 +31,6 @@ tags:
- 'lunch and learns'
---

Below is the entire lifecycle of a Virtual Coffee Lunch & Learn session.

## Roles

There are several moving parts to making a successful Lunch & Learn. These docs are organized as to not assume one person is doing multiple roles (they could but they don't have to). It will also make it easy to assign roles as needed as our volunteer groups expand and contract.
Expand Down Expand Up @@ -85,6 +83,26 @@ Includes Editors and Graphics Coordinator (GC) who handle post-event cleanup of

#### Scheduling Workflow

The following diagram shows the workflow for scheduling a Lunch & Learn.

```mermaid
%%{init: { "themeVariables": { "fontSize": "18px" }, "flowchart": { "nodeSpacing": 40, "rankSpacing": 60, "padding": 8, "htmlLabels": true } } }%%
flowchart TB
A1[📝 Submit Request] --> A2[📥 Receive Form]
A2 --> A3[📅 Check Calendar]
A3 --> B1{📅 Dates?}
B1 -- Yes --> B2[✅ Confirm Host]
B2 --> B3[📧 Confirm Email]
B3 --> B4[📅 Add to Cal]
B4 --> B5[🗂 Update Issue]
B1 -- No --> C1[🔄 Request New Slots]
C1 --> C2[📬 Receive Options]
C2 --> D1{✅ Options OK?}
D1 -- Yes --> A3
D1 -- No --> C3[🕒 Set New Deadline]
C3 --> C1
```

1. The LC checks the calendar for availability in order of the Speaker's preferred dates.

a. If any of the Speaker's suggested time slots are available, continue to step 2.
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -37,6 +37,52 @@ Let us know your availability for the challenge in the reminder thread that drop

If you have ideas for a new challenge(s), you can propose and discuss them in the `#vc-monthly-challenge-team` channel on Slack or open a new [discussion on GitHub](https://github.com/Virtual-Coffee/VC-Community-Docs/discussions).

Below is a diagram the Monthly Challenge workflow.

#### Planning + Coordination

```mermaid
%%{init: { "themeVariables": { "fontSize": "20px" }, "flowchart": { "nodeSpacing": 50, "rankSpacing": 70, "padding": 10 } } }%%
flowchart TB
A1[📢 Planning] --> A2[👥 Share Time]
A2 --> A3[📝 Propose]
A3 --> B1[🤝 Plan w/ Hosts]
```

#### Blog + Website

```mermaid
%%{init: { "themeVariables": { "fontSize": "20px" }, "flowchart": { "nodeSpacing": 50, "rankSpacing": 70, "padding": 10 } } }%%
flowchart TB
C1[📝 Write Blog] --> C2[🔍 Proofread]
C2 --> D0{✅ OK?}
D0 -- Yes --> D1[🌐 Update Pages]
D0 -- No --> D2[✏️ Revise]
D2 --> C2
```

#### Announcement

```mermaid
%%{init: { "themeVariables": { "fontSize": "20px" }, "flowchart": { "nodeSpacing": 50, "rankSpacing": 70, "padding": 10 } } }%%
flowchart TB
E1[📢 Update] --> E2[📢 Announce]
```

#### Check-Ins + Post-Challenge

```mermaid
%%{init: { "themeVariables": { "fontSize": "20px" }, "flowchart": { "nodeSpacing": 50, "rankSpacing": 70, "padding": 10 } } }%%
flowchart TB
F1[📅 Goals] --> F2[💬 Weekly]
F2 --> F3[🤖 Automate]
F3 --> G1[💬 Feedback]
G1 --> G0{More updates?}
G0 -- Yes --> G2[📝 Update Docs]
G2 --> G1
G0 -- No --> H1[🏁]
```

## Before the Challenge

### Coordinating with the Coffee Table Groups
Expand Down Expand Up @@ -105,7 +151,6 @@ Some challenges require daily check-in. You can automate it using the Slack bot.

- Provide feedback in the `#vc-monthly-challenge-team` channel, like what went well and what could've gone better for the challenge. Let us know what support you need and what things you think would be nice to do next time.
- Update the README file in the challenge's folder with:

- new script templates and things we did for the challenge,
- the month and year of the challenge,
- the blog post(s) for the challenge, if any.
32 changes: 31 additions & 1 deletion docusaurus.config.js
Original file line number Diff line number Diff line change
Expand Up @@ -52,7 +52,11 @@ const config = {
}),
],
],

// These lines enable Mermaid support ✅
markdown: {
mermaid: true,
},
themes: ['@docusaurus/theme-mermaid'],
themeConfig: {
// Replace with your project's social card
image: 'img/vc-social-card.png',
Expand All @@ -62,6 +66,32 @@ const config = {
hideable: true,
},
},
// Site-wide Mermaid defaults for consistent sizing
mermaid: {
theme: { light: 'neutral', dark: 'neutral' },
options: {
themeVariables: {
fontSize: '20px',
fontFamily:
"Inter, system-ui, -apple-system, 'Segoe UI', Roboto, 'Helvetica Neue', Arial, 'Noto Sans', 'Apple Color Emoji', 'Segoe UI Emoji'",
lineColor: '#6B7280',
primaryColor: '#FFF7D6',
primaryTextColor: '#1F2937',
primaryBorderColor: '#F59E0B',
tertiaryColor: '#E5F3FF',
clusterBkg: '#F9FAFB',
edgeLabelBackground: '#FFFFFF',
nodeBorderRadius: 8,
},
flowchart: {
nodeSpacing: 50,
rankSpacing: 70,
padding: 10,
htmlLabels: true,
curve: 'basis',
},
},
},
navbar: {
title: 'Virtual Coffee Community Docs',
logo: {
Expand Down
13 changes: 7 additions & 6 deletions package.json
Original file line number Diff line number Diff line change
Expand Up @@ -17,17 +17,18 @@
"check": "prettier --ignore-unknown --list-different --check ."
},
"dependencies": {
"@docusaurus/core": "3.7.0",
"@docusaurus/preset-classic": "3.7.0",
"@docusaurus/core": "3.9.2",
"@docusaurus/preset-classic": "3.9.2",
"@docusaurus/theme-mermaid": "3.9.2",
"@mdx-js/react": "^3.0.0",
"clsx": "^2.0.0",
"prism-react-renderer": "^2.3.0",
"react": "^19.0.0",
"react-dom": "^19.0.0"
"react": "^18.3.1",

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

What's going on here?

@CBID2 CBID2 Mar 28, 2026

Copy link
Copy Markdown
Author

Choose a reason for hiding this comment

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

Hey @BekahHW. When I was working on the PR, the mermaid diagram feature was not working initially due to compatibility issues, so I had to downgrade React from 19 to 18.3.1. I also changed the order of the diagrams like you asked. Here they are

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

I'm not super comfortable downgrading the version. Can you explore some other solutions and present them?

Copy link
Copy Markdown
Author

Choose a reason for hiding this comment

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

Hi @BekahHW,

Thanks for the feedback! I did some exploring and it turns out the problem isn't really about version compatibility at all. The Docusaurus Mermaid theme is looking for an optional dependency called @mermaid-js/layout-elk that's not installed, and that's what's causing the build to fail.

As far as solutions, here's what I came up with:

Option 1: Add the missing dependency

pnpm add @mermaid-js/layout-elk

This would be the simplest fix - just installing what the theme is expecting to find.

Option 2: Upgrade to the latest Docusaurus version

pnpm add @docusaurus/core@latest @docusaurus/preset-classic@latest @docusaurus/theme-mermaid@latest

Sometimes, newer versions have better dependency handling.

Option 3: Convert to static images
We could export the diagrams as PNG/SVG files and just include them as regular images in the docs.

Option 4: Disable the ELK layout feature
There's a config option we could add to turn off the specific feature that's causing the issue.

Personally, I think Option 1 would be suited to solve your concern. It's the most straightforward and keeps everything working as intended. What do you think?

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

  1. Preferred: React 19 + Docusaurus Mermaid + simpler Mermaid diagrams.
  2. Acceptable if required: React 19 + Docusaurus Mermaid + @mermaid-js/layout-elk.

"react-dom": "^18.3.1"
},
"devDependencies": {
"@docusaurus/module-type-aliases": "3.7.0",
"@docusaurus/types": "3.7.0",
"@docusaurus/module-type-aliases": "3.9.2",
"@docusaurus/types": "3.9.2",
"prettier": "^2.2.1"
},
"browserslist": {
Expand Down
Loading