Enhance README with architecture and logic flow diagrams#75
Merged
Conversation
Added architecture diagrams to explain system data flow, authentication lifecycle, and report generation pipeline.
|
@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. |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
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:
Type of Change
Proof of Work
I have verified that the Mermaid.js blocks render correctly in both GitHub Dark and Light modes.
Checklist
Related Issue
Closes #68