📝[Docs]: Missing Project Structure in README

[Niranjan421]

Is there an existing issue for this?

• I have searched the existing issues

Issue Description

Description

The README.md file currently lacks a section that outlines the project's folder and file structure. Including a well-defined project structure would significantly help new contributors and users understand the organization of the codebase quickly.

Why This Is Important

• Helps newcomers navigate the project more efficiently.
• Increases the maintainability and onboarding experience.
• Makes the project more developer-friendly and open-source ready.

Suggested Structure (Example)

Here's a proposed structure that could be added to the README:

Describe the solution you'd like

please assing me this issue

Suggested Change

I would like to see a clearly defined "Project Structure" section added to the README.md file. This section should list the key directories and files in a tree-like format, along with short descriptions of their purpose.

For example:

Rationale

No response

Urgency

Medium

Record

• I have read the Contributing Guidelines
• I'm a GSSOC'25 contributor
• I want to work on this issue

[github-actions]

Hi there! Thanks for opening this issue. We appreciate your contribution to this open-source project. We aim to respond or assign your issue as soon as possible. @sourabhkumar47 is going to assign this issue as soon as possible.

[sourabhkumar47]

Assigned!

[Niranjan421]

@sourabhkumar47 can you please add lables

[Niranjan421]

@sourabhkumar47 please add lables

[github-actions]

Hello @Niranjan421! Your issue #169 has been closed. Thank you for your contribution!