docs: add PROJECT_ARCHITECTURE.md (project overview & architecture)#200
Open
arnavgoel17 wants to merge 1 commit into
Open
docs: add PROJECT_ARCHITECTURE.md (project overview & architecture)#200arnavgoel17 wants to merge 1 commit into
arnavgoel17 wants to merge 1 commit into
Conversation
…flow Adds a dedicated architecture document covering the high-level overview, repository structure with per-folder descriptions, an architecture diagram (ASCII + Mermaid), the data flow / execution pipeline, key modules and their responsibilities, and component dependencies. Also links the doc from README. Closes AditixAnand#199 Co-Authored-By: Claude <noreply@anthropic.com>
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
Closes #199.
Adds a dedicated
PROJECT_ARCHITECTURE.mdso new contributors can understand how EduBridge is organized and how the pieces interact, and links it from the README.What's included
/chatendpoint contract and how to run itlocalStorageschema tableserver/Node experiments and the straybackend/appduplicate, so newcomers aren't confused about which backend is liveEverything is derived from reading the actual code (
scripts/*.js,backend/app.py,server/*.js, and the HTML pages), so it reflects the current implementation rather than aspirational structure.Notes