Add architecture diagram and documentation link in README#59
Open
Prerna-Prahsar wants to merge 1 commit intokaushav07:mainfrom
Open
Add architecture diagram and documentation link in README#59Prerna-Prahsar wants to merge 1 commit intokaushav07:mainfrom
Prerna-Prahsar wants to merge 1 commit intokaushav07:mainfrom
Conversation
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
1 participant
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.
Suggested Issue Description
Title: Add architecture diagram and documentation to the project
Description:
I have added a new docs folder to the project containing:
Architecture Diagram (architecture.png) – Visual representation of the system design.
Architecture Documentation (architecture.md) – Detailed explanation of project components and workflow.
I have also updated the README.md to:
Include the architecture diagram so it is visible when viewing the repository.
Add a link to the detailed architecture documentation for developers and contributors.
This addition will help contributors understand the project structure and make onboarding easier.