Skip to content

Enhance README with architecture and logic flow diagrams#75

Merged
iTusharyadav merged 1 commit into
iTusharyadav:mainfrom
Nitya-003:main
Feb 21, 2026
Merged

Enhance README with architecture and logic flow diagrams#75
iTusharyadav merged 1 commit into
iTusharyadav:mainfrom
Nitya-003:main

Conversation

@Nitya-003

Copy link
Copy Markdown
Contributor

Summary of Changes

This PR introduces a dedicated Architecture & Logic Flow section to the README.md. As Proofolio processes complex data streams from GitHub, LinkedIn, and Blogs, these diagrams provide a "birds-eye view" for SWOC '26 contributors to better understand the system's integration points.

Key Visualizations Added:

  1. System Data Flow: Highlighting the relationship between External APIs, the React Frontend, and the Supabase Backend/AI Engine.
  2. Authentication Lifecycle: Detailng the Supabase Auth flow and JWT session persistence within the React Context API.
  3. Report Generation Pipeline: Visualizing the data transformation from raw stats to Recharts and finally to PDF via jsPDF.

Type of Change

  • chore (Documentation enhancement for SWOC '26)

Proof of Work

I have verified that the Mermaid.js blocks render correctly in both GitHub Dark and Light modes.

Checklist

  • My PR contains exactly one commit (squashed).
  • I have followed the SWOC Project Admin (PA) Playbook for documentation standards.
  • I have verified the diagrams accurately reflect the current project structure.

Related Issue

Closes #68

Added architecture diagrams to explain system data flow, authentication lifecycle, and report generation pipeline.
@vercel

vercel Bot commented Feb 16, 2026

Copy link
Copy Markdown

@Nitya-003 is attempting to deploy a commit to the Diego's projects Team on Vercel.

A member of the Team first needs to authorize it.

@iTusharyadav iTusharyadav merged commit 68d072c into iTusharyadav:main Feb 21, 2026
1 of 3 checks passed
@iTusharyadav iTusharyadav added SWoC26 Issues suitable for Social Winter of Code (SWOC) contributors Easy labels Feb 21, 2026
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

Easy SWoC26 Issues suitable for Social Winter of Code (SWOC) contributors

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Add Mermaid.js Visual Architecture & Data Flow to README

2 participants