Skip to content

Commit efef520

Browse files
CBID2CBID2
committed
style: update Mermaid diagrams and section styling for consistency
- Standardized section headings and spacing - Improved Mermaid diagram readability - Made CFP section more prominent - Ensured consistent sizing across all sections
1 parent 6ea4bfc commit efef520

File tree

4 files changed

+349
-104
lines changed

4 files changed

+349
-104
lines changed

‎docs/lightning-talks/processes/project-workflow.md‎

Lines changed: 114 additions & 32 deletions
Original file line numberDiff line numberDiff line change
@@ -37,64 +37,146 @@ The function of the Lightning Talks Event is to allow opportunities for members
3737

3838
Below is the workflow for the Lightning Talks Event.
3939

40-
#### Planning
40+
### Planning {#planning-section}
4141

4242
```mermaid
43-
%%{init: { "themeVariables": { "fontSize": "20px" }, "flowchart": { "nodeSpacing": 50, "rankSpacing": 60, "padding": 4 } } }%%
44-
flowchart TB
45-
A1[📢 Call for Team] --> A2[👥 Onboard Team]
46-
A2 --> A3[📝 Assign Coordinators]
43+
flowchart LR
44+
%% Left Column - Team Formation
45+
subgraph A[👥 Team Formation]
46+
A1[📢 Call for Team] --> A2[👥 Onboard Team]
47+
A2 --> A3[📝 Assign Coordinators]
48+
end
49+
50+
%% Styling
51+
classDef default fill:#f5f5f5,stroke:#2e8555,stroke-width:2px,color:#333;
52+
classDef process fill:#e6f3ed,stroke:#2e8555,stroke-width:2px,color:#333;
53+
class A process;
54+
55+
%% Adjust width to match other sections
56+
style A width: 300px
4757
```
4858

49-
#### CFP
59+
### 📢 CFP (Call For Proposals) {#cfp-section}
5060

61+
<div class="mermaid-cfp">
5162
```mermaid
52-
%%{init: { "themeVariables": { "fontSize": "20px" }, "flowchart": { "nodeSpacing": 50, "rankSpacing": 60, "padding": 4 } } }%%
53-
flowchart TB
54-
B1[📣 CFP Opens] --> B2[🧾 Collect Proposals]
55-
B2 --> B0{Enough?}
56-
B0 -- Yes --> B3[👩‍💻 Grouping]
57-
B0 -- No --> B4[📣 Extend CFP]
58-
B4 --> B2
63+
flowchart LR
64+
%% Left Column - Proposal Collection
65+
subgraph A[📬 Proposal Collection]
66+
A1[📣 CFP Opens] --> A2[🧾 Collect Proposals]
67+
A2 --> A3{Enough?}
68+
A3 -- No --> A4[📢 Extend CFP]
69+
A4 --> A2
70+
end
71+
72+
%% Right Column - Scheduling
73+
subgraph B[📅 Scheduling]
74+
B1[👩‍💻 Grouping] --> B2[📅 Schedule Talks]
75+
B2 --> B3[📝 Send Confirmations]
76+
B3 --> B4[📅 Add to Calendar]
77+
B4 --> B5[📢 Share Schedule]
78+
end
79+
80+
%% Flow between columns
81+
A3 -- Yes --> B1
82+
83+
%% Styling
84+
classDef default fill:#f0f7ff,stroke:#1976d2,stroke-width:2px,color:#0d47a1;
85+
classDef process fill:#e3f2fd,stroke:#1976d2,stroke-width:2px,color:#0d47a1;
86+
classDef decision fill:#fff8e1,stroke:#ff8f00,stroke-width:2px,color:#e65100;
87+
class A,B process;
88+
class A3 decision;
89+
90+
%% Adjust spacing
91+
style A width: 350px
92+
style B width: 350px
93+
94+
%% Make the diagram more compact
95+
linkStyle default stroke-width:1.5px,fill:none,stroke:#1976d2
5996
```
97+
</div>
6098

6199
#### Speaker Prep
62100

63101
```mermaid
64-
%%{init: { "themeVariables": { "fontSize": "20px" }, "flowchart": { "nodeSpacing": 50, "rankSpacing": 70, "padding": 10 } } }%%
65-
flowchart TB
66-
C1[🗂 Organize Talks] --> C2[✅ Checklists]
67-
C2 --> C0{Missing?}
68-
C0 -- Yes --> C5[📬 Request Info]
69-
C5 --> C2
70-
C0 -- No --> C3[📸 Speaker Info]
71-
C3 --> C4[📁 Shared Folder]
102+
flowchart LR
103+
%% Left Column - Talk Organization
104+
subgraph A[🗂 Talk Preparation]
105+
A1[🗂 Organize Talks] --> A2[✅ Checklists]
106+
A2 --> A3{Missing?}
107+
A3 -- Yes --> A4[📬 Request Info]
108+
A4 --> A2
109+
end
110+
111+
%% Right Column - Speaker Materials
112+
subgraph B[👤 Speaker Materials]
113+
B1[📸 Speaker Info] --> B2[📁 Shared Folder]
114+
end
115+
116+
%% Flow between columns
117+
A3 -- No --> B1
118+
119+
%% Styling
120+
classDef default fill:#f5f5f5,stroke:#2e8555,stroke-width:2px,color:#333;
121+
classDef process fill:#e6f3ed,stroke:#2e8555,stroke-width:2px,color:#333;
122+
class A,B process;
72123
```
73124

74125
#### Event
75126

76127
```mermaid
77-
%%{init: { "themeVariables": { "fontSize": "20px" }, "flowchart": { "nodeSpacing": 50, "rankSpacing": 70, "padding": 10 } } }%%
78-
flowchart TB
79-
D1[🧾 Final Prep] --> D2[📨 Directions]
80-
D2 --> D3[🧑‍🏫 Talks]
128+
flowchart LR
129+
%% Left Column - Pre-Event
130+
subgraph A[📋 Pre-Event]
131+
A1[🧾 Final Prep] --> A2[📨 Directions to Speakers]
132+
end
133+
134+
%% Right Column - Event
135+
subgraph B[🎤 Event]
136+
B1[🎬 Start Recording] --> B2[🧑‍🏫 Talks Begin]
137+
end
138+
139+
%% Flow between columns
140+
A2 --> B1
141+
142+
%% Styling
143+
classDef default fill:#f5f5f5,stroke:#2e8555,stroke-width:2px,color:#333;
144+
classDef process fill:#e6f3ed,stroke:#2e8555,stroke-width:2px,color:#333;
145+
class A,B process;
81146
```
82147

83148
#### Post-Event
84149

85150
```mermaid
86-
%%{init: { "themeVariables": { "fontSize": "20px" }, "flowchart": { "nodeSpacing": 50, "rankSpacing": 70, "padding": 10 } } }%%
87-
flowchart TB
88-
E1[☁️ Upload to YouTube]
151+
flowchart LR
152+
%% Left Column - Video Processing
153+
subgraph A[🎥 Video Processing]
154+
A1[📹 Process Recording] --> A2[☁️ Upload to YouTube]
155+
A2 --> A3[📝 Add Description & Tags]
156+
end
157+
158+
%% Right Column - Follow-up
159+
subgraph B[📣 Follow-up]
160+
B1[🙏 Thank Speakers] --> B2[📊 Gather Feedback]
161+
B2 --> B3[📈 Review Metrics]
162+
end
163+
164+
%% Flow between columns
165+
A3 --> B1
166+
167+
%% Styling
168+
classDef default fill:#f5f5f5,stroke:#2e8555,stroke-width:2px,color:#333;
169+
classDef process fill:#e6f3ed,stroke:#2e8555,stroke-width:2px,color:#333;
170+
class A,B process;
89171
```
90172

91-
### Specifics
173+
### Specifics {#specifics-section}
92174

93175
- 5-15 minutes on one topic
94176
- Slides are optional
95177
- Mentorship is provided if requested
96178

97-
### Timeline
179+
### Timeline {#timeline-section}
98180

99181
#### Call for coordinators, mentors, and other teammates
100182

@@ -104,7 +186,7 @@ flowchart TB
104186
- This will allow quick response times.
105187
- Team meeting
106188

107-
#### CFP
189+
### CFP (Call For Proposals)
108190

109191
- This should end at least six weeks before the event.
110192
- Start with a date and time TBA during proposal stage.
@@ -127,7 +209,7 @@ flowchart TB
127209
- Send message to speaker channel with direction the week of - Let them know there’s a lag between the stream and the speaker - Ask them to mute or better yet, hide your youtube stream
128210
(For ref: Bc there is a lag, if you’re watching and up next, you’ll be introduced before the next talk is over.)
129211

130-
### Communication
212+
### Communication {#communication-section}
131213

132214
#### For LT Team
133215

‎docs/lunch-and-learns/process-docs.md‎

Lines changed: 22 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -86,21 +86,28 @@ Includes Editors and Graphics Coordinator (GC) who handle post-event cleanup of
8686
The following diagram shows the workflow for scheduling a Lunch & Learn.
8787

8888
```mermaid
89-
%%{init: { "themeVariables": { "fontSize": "18px" }, "flowchart": { "nodeSpacing": 40, "rankSpacing": 60, "padding": 8, "htmlLabels": true } } }%%
90-
flowchart TB
91-
A1[📝 Submit Request] --> A2[📥 Receive Form]
92-
A2 --> A3[📅 Check Calendar]
93-
A3 --> B1{📅 Dates?}
94-
B1 -- Yes --> B2[✅ Confirm Host]
95-
B2 --> B3[📧 Confirm Email]
96-
B3 --> B4[📅 Add to Cal]
97-
B4 --> B5[🗂 Update Issue]
98-
B1 -- No --> C1[🔄 Request New Slots]
99-
C1 --> C2[📬 Receive Options]
100-
C2 --> D1{✅ Options OK?}
101-
D1 -- Yes --> A3
102-
D1 -- No --> C3[🕒 Set New Deadline]
103-
C3 --> C1
89+
flowchart LR
90+
%% Left Column - Initial Request
91+
subgraph A[📬 Request Submission]
92+
A1[📅 Speaker Submits Request] --> A2[📋 LC Reviews Request]
93+
end
94+
95+
%% Right Column - Date Selection
96+
subgraph B[📅 Date Coordination]
97+
B1[🗓 Check Calendar] --> B2[⏰ Check Time Slots]
98+
B2 --> B3{✅ Options OK?}
99+
B3 -- Yes --> B4[📅 Date Confirmed]
100+
B3 -- No --> B5[🔄 Request New Dates]
101+
B5 --> B1
102+
end
103+
104+
%% Flow between columns
105+
A2 --> B1
106+
107+
%% Styling
108+
classDef default fill:#f5f5f5,stroke:#2e8555,stroke-width:2px,color:#333;
109+
classDef process fill:#e6f3ed,stroke:#2e8555,stroke-width:2px,color:#333;
110+
class A,B process;
104111
```
105112

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

‎docs/monthly-challenges/facilitators-docs/facilitate-a-challenge.md‎

Lines changed: 85 additions & 24 deletions
Original file line numberDiff line numberDiff line change
@@ -42,45 +42,106 @@ Below is a diagram the Monthly Challenge workflow.
4242
#### Planning + Coordination
4343

4444
```mermaid
45-
%%{init: { "themeVariables": { "fontSize": "20px" }, "flowchart": { "nodeSpacing": 50, "rankSpacing": 70, "padding": 10 } } }%%
46-
flowchart TB
47-
A1[📢 Planning] --> A2[👥 Share Time]
48-
A2 --> A3[📝 Propose]
49-
A3 --> B1[🤝 Plan w/ Hosts]
45+
flowchart LR
46+
%% Left Column - Initial Planning
47+
subgraph A[📅 Initial Planning]
48+
A1[🗓 Review Schedule] --> A2[👥 Coordinate with Team]
49+
A2 --> A3[💡 Propose Ideas]
50+
end
51+
52+
%% Right Column - Coordination
53+
subgraph B[🤝 Team Coordination]
54+
B1[📧 Contact Hosts] --> B2[📅 Align Schedules]
55+
B2 --> B3[✅ Finalize Plan]
56+
end
57+
58+
%% Flow between columns
59+
A3 --> B1
60+
61+
%% Styling
62+
classDef default fill:#f5f5f5,stroke:#2e8555,stroke-width:2px,color:#333;
63+
classDef process fill:#e6f3ed,stroke:#2e8555,stroke-width:2px,color:#333;
64+
class A,B process;
5065
```
5166

5267
#### Blog + Website
5368

5469
```mermaid
55-
%%{init: { "themeVariables": { "fontSize": "20px" }, "flowchart": { "nodeSpacing": 50, "rankSpacing": 70, "padding": 10 } } }%%
56-
flowchart TB
57-
C1[📝 Write Blog] --> C2[🔍 Proofread]
58-
C2 --> D0{✅ OK?}
59-
D0 -- Yes --> D1[🌐 Update Pages]
60-
D0 -- No --> D2[✏️ Revise]
61-
D2 --> C2
70+
flowchart LR
71+
%% Left Column - Content Creation
72+
subgraph A[📝 Content Creation]
73+
A1[✍️ Draft Blog Post] --> A2[👥 Team Review]
74+
A2 --> A3{Approved?}
75+
A3 -- No --> A4[✏️ Revise Content]
76+
A4 --> A2
77+
end
78+
79+
%% Right Column - Publication
80+
subgraph B[🌐 Website Updates]
81+
B1[📝 Update Website] --> B2[🔍 Review Changes]
82+
B2 --> B3[✅ Publish Updates]
83+
end
84+
85+
%% Flow between columns
86+
A3 -- Yes --> B1
87+
88+
%% Styling
89+
classDef default fill:#f5f5f5,stroke:#2e8555,stroke-width:2px,color:#333;
90+
classDef process fill:#e6f3ed,stroke:#2e8555,stroke-width:2px,color:#333;
91+
class A,B process;
6292
```
6393

6494
#### Announcement
6595

6696
```mermaid
67-
%%{init: { "themeVariables": { "fontSize": "20px" }, "flowchart": { "nodeSpacing": 50, "rankSpacing": 70, "padding": 10 } } }%%
68-
flowchart TB
69-
E1[📢 Update] --> E2[📢 Announce]
97+
flowchart LR
98+
%% Left Column - Preparation
99+
subgraph A[📢 Preparation]
100+
A1[📝 Draft Announcement] --> A2[👥 Team Review]
101+
A2 --> A3{Approved?}
102+
A3 -- No --> A4[✏️ Revise]
103+
A4 --> A2
104+
end
105+
106+
%% Right Column - Distribution
107+
subgraph B[📣 Distribution]
108+
B1[📧 Email List] --> B2[💬 Slack Channels]
109+
B2 --> B3[📱 Social Media]
110+
end
111+
112+
%% Flow between columns
113+
A3 -- Yes --> B1
114+
115+
%% Styling
116+
classDef default fill:#f5f5f5,stroke:#2e8555,stroke-width:2px,color:#333;
117+
classDef process fill:#e6f3ed,stroke:#2e8555,stroke-width:2px,color:#333;
118+
class A,B process;
70119
```
71120

72121
#### Check-Ins + Post-Challenge
73122

74123
```mermaid
75-
%%{init: { "themeVariables": { "fontSize": "20px" }, "flowchart": { "nodeSpacing": 50, "rankSpacing": 70, "padding": 10 } } }%%
76-
flowchart TB
77-
F1[📅 Goals] --> F2[💬 Weekly]
78-
F2 --> F3[🤖 Automate]
79-
F3 --> G1[💬 Feedback]
80-
G1 --> G0{More updates?}
81-
G0 -- Yes --> G2[📝 Update Docs]
82-
G2 --> G1
83-
G0 -- No --> H1[🏁]
124+
flowchart LR
125+
%% Left Column - During Challenge
126+
subgraph A[📅 During Challenge]
127+
A1[🎯 Set Goals] --> A2[💬 Weekly Check-ins]
128+
A2 --> A3[👥 Community Engagement]
129+
end
130+
131+
%% Right Column - Post Challenge
132+
subgraph B[📊 Post-Challenge]
133+
B1[📝 Gather Feedback] --> B2[📊 Review Outcomes]
134+
B2 --> B3[📚 Update Documentation]
135+
B3 --> B4[🎉 Celebrate Success]
136+
end
137+
138+
%% Flow between columns
139+
A3 --> B1
140+
141+
%% Styling
142+
classDef default fill:#f5f5f5,stroke:#2e8555,stroke-width:2px,color:#333;
143+
classDef process fill:#e6f3ed,stroke:#2e8555,stroke-width:2px,color:#333;
144+
class A,B process;
84145
```
85146

86147
## Before the Challenge

0 commit comments

Comments
 (0)