Skip to content

Conversation

@CBID2
Copy link

@CBID2 CBID2 commented Oct 5, 2025

Linked Issue

Closes #516

Description

This pull request adds Mermaid diagram support to the Virtual Coffee Community Docs and introduces visual workflows for three major community processes:

  • Lightning Talk Project Workflow — docs/lightning-talks/processes/project-workflow.md
  • Facilitating a Challenge — docs/monthly-challenges/facilitate-a-challenge.md
  • Lunch & Learn Guidelines — docs/lunch-and-learns/process-docs.md

These diagrams provide an at-a-glance overview of how each process flows, making it easier for new volunteers and contributors to understand their roles and responsibilities.

@BekahHW — I’d love your feedback to confirm that these diagrams accurately reflect the intended steps for each process.

Methodology

Following the official Docusaurus v3 Mermaid integration guide, I
:

  1. Added @docusaurus/theme-mermaid to the configuration and enabled Markdown support.
  2. Translated three existing textual workflows into clear, concise Mermaid diagrams.
  3. Ensured consistency in visual style and logical flow across all diagrams.
  4. Tested each Markdown file to confirm correct rendering in local preview.

These changes improve readability, onboarding efficiency, and process transparency by combining structured documentation with visual context.

Code of Conduct

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

@netlify
Copy link

netlify bot commented Oct 5, 2025

Deploy Preview for vc-community-docs failed. Why did it fail? →

Name Link
🔨 Latest commit 8be530c
🔍 Latest deploy log https://app.netlify.com/projects/vc-community-docs/deploys/68e98da003cfd900082fb885

@CBID2 CBID2 marked this pull request as ready for review October 5, 2025 01:22
@CBID2 CBID2 requested review from a team as code owners October 5, 2025 01:22
@BekahHW
Copy link
Member

BekahHW commented Oct 6, 2025

@CBID2 have you tested this locally to see if it renders? It would be useful to have some screenshots in your PR. Looks like the deploy preview is broken bc of some errors, so ping me once you get those fixed.

@CBID2
Copy link
Author

CBID2 commented Oct 10, 2025

https://app.netlify.com/projects/vc-community-docs/deploys/68e1cc979f4b06000897cff6

Hi @BekahHW! :) When I test it locally, I got this:
error page. Maybe it's something on the repo's end? 🤔

@adiati98
Copy link
Contributor

@CBID2 I assumed from your PR descriptions, you've seen the diagrams. Can you please share the screenshots?

But if you see "Page not found" locally, perhaps it hasn't work yet and that's why all checks are failed.

@BekahHW
Copy link
Member

BekahHW commented Oct 11, 2025

Did you look through the netlify error log? They identify what they think the cause is.

trim.406B551A-F97B-4CEE-8128-BEE77B685B78.MOV

@CBID2
Copy link
Author

CBID2 commented Oct 11, 2025

I'm going to try and create a new PR

@CBID2
Copy link
Author

CBID2 commented Oct 12, 2025

I solved the issue in PR #521 @BekahHW and @adiati98

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Add process flowcharts and diagrams for complex workflows

3 participants