You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
The current README has several critical sections commented out using Markdown comment tags, including GirlScript Summer of Code (GSSoC) status and upcoming milestones.
Additionally, as the repository scales with more contributors, we need a clear visual guide to help developers understand how the frontend components load data. Adding a Mermaid.js structural diagram will allow new contributors to instantly see how modifying files under src/data/ dynamically updates sections like the Mentors, Learning Path, and Storyboard components.
Tasks & Steps to Implement
1. Badge Configuration Update
Locate the commented-out badge block near the top of the file:
Remove the comment wrapper and restore the live GirlScript Summer of Code program banner right alongside the MIT and PRs Welcome badges.
2. Restore Roadmap Details
Locate the inline commented block inside the What is HerStack? overview:
[//]: #(And coming in 2026: **HerStack Summer of AI** — an open source program where girls contribute to real AI projects, get paired with women mentors, and earn a certificate.)
Uncomment this line and format it cleanly to highlight the active timeline.
3. Add System Architecture Diagram (Mermaid.js)
Insert a new ## System Architecture section right before Getting Started.
Add the following Mermaid flow diagram to visualize the relationship between the data files and presentation layout components:
graph TD
subgraph "Data Layer (src/data/)"
A[mentors.js]
B[resources.js]
C[storyboards.js]
end
subgraph "Core App Shell"
Root[App.jsx]
Nav[Nav.jsx]
Footer[Footer.jsx]
end
subgraph "Presentation Layer (src/components/)"
D[Mentors.jsx]
E[LearningPath.jsx]
F[Storyboards.jsx]
G[SummerOfAI.jsx]
end
Root --> Nav
Root --> G
Root --> Footer
%% Data Ingestion Mapping
A -->|Maps profiles| D
B -->|Maps courses| E
C -->|Maps concept UI| F
Root --> D
Root --> E
Root --> F
Loading
4. Uncomment & Format GSSoC Section
Scroll to the bottom of the document and remove the HTML comment wrappers around the placeholder GirlScript Summer of Code section.
Refactor the section text to clearly guide participants:
## GirlScript Summer of Code
This project is an official part of **GirlScript Summer of Code (GSSoC)**!
If you are a participant looking to contribute:
1. Head over to our **[Issues](../../issues)** tab.
2. Filter by the `gssoc` or `good first issue` labels.
3. Comment on the issue you'd like to claim before starting work to avoid overlapping Pull Requests.
5. Clean up Markdown Noise
Scan the file for remaining empty comment flags like [//]: # () and permanently delete them to ensure clean markdown formatting.
Expected Outcome
An updated, fully transparent landing document that showcases our GSSoC alignment and visually charts our directory logic so new developers can easily map out their frontend updates.
Type
Description
The current README has several critical sections commented out using Markdown comment tags, including GirlScript Summer of Code (GSSoC) status and upcoming milestones.
Additionally, as the repository scales with more contributors, we need a clear visual guide to help developers understand how the frontend components load data. Adding a Mermaid.js structural diagram will allow new contributors to instantly see how modifying files under
src/data/dynamically updates sections like the Mentors, Learning Path, and Storyboard components.Tasks & Steps to Implement
1. Badge Configuration Update
2. Restore Roadmap Details
3. Add System Architecture Diagram (Mermaid.js)
## System Architecturesection right before Getting Started.graph TD subgraph "Data Layer (src/data/)" A[mentors.js] B[resources.js] C[storyboards.js] end subgraph "Core App Shell" Root[App.jsx] Nav[Nav.jsx] Footer[Footer.jsx] end subgraph "Presentation Layer (src/components/)" D[Mentors.jsx] E[LearningPath.jsx] F[Storyboards.jsx] G[SummerOfAI.jsx] end Root --> Nav Root --> G Root --> Footer %% Data Ingestion Mapping A -->|Maps profiles| D B -->|Maps courses| E C -->|Maps concept UI| F Root --> D Root --> E Root --> F4. Uncomment & Format GSSoC Section
5. Clean up Markdown Noise
Expected Outcome
Assign me this issue under GSSoC'26!
Labels:
GSSOC'26,documentation,refactor