Add PROJECT_STRUCTURE.md to Document the Repo Structure #4941
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.
This PR introduces a new file, PROJECT_STRUCTURE.md, which provides a comprehensive overview of the folder and file organization within the SwapReads repository. This addition helps current and future contributors easily navigate the project by understanding its structure at a glance.
Changes:
Motivation:
This document will serve as a helpful reference for anyone working on the project, making it easier to find and understand different parts of the codebase. It improves the overall documentation and contributes to a more organized project structure.
fixes: #4937
Kindly merge it with level 3 @abhi03ruchi @sailaja-adapa