[Doc]: Adding a Project Structure Map in the Documentation

[siri-chandana-macha]

Is there an existing issue for this?

• I have searched the existing issues

Issue Description

Add a clear structure map in the documentation to guide contributors on where specific files and folders are located and what they contain.

Suggested Change

For example:

Project Root
├── src/      # Core application files
│ ├── components/      # Reusable UI components
│ ├── services/      # API calls and business logic
│ ├── utils/      # Utility functions
│ └── index.js      # Main entry file
├── assets/      # Images, icons, and other static assets
├── config/      # Configuration files (e.g., env variables)
└── README.md      # Project overview and instructions

Rationale

This helps new contributors quickly understand the project layout and find files easily.

Urgency

Medium

Acknowledgements

• I'm a GSSOC'24-Extd contributor
• I'm a Hacktoberfest contributor
• I am willing to work on this issue (optional)

[github-actions]

Thank you for creating this issue! 🎉 We'll look into it as soon as possible.

[github-actions]

🎉 Thank you for raising an issue in this repository!
We’ll review and assign it to you soon.
In the meantime, feel free to ⭐ the repo for updates.
Stay awesome! 😎

[rishicds]

Assigned, if you can create a github workflow to create this structure automatically everytime there's a change I will make it level 2

[siri-chandana-macha]

Ok

…

On Sat, 2 Nov, 2024, 4:55 pm Rishi, ***@***.***> wrote: Assigned, if you can create a github workflow to create this structure automatically everytime there's a change I will make it level 2 — Reply to this email directly, view it on GitHub <#373 (comment)>, or unsubscribe <https://github.com/notifications/unsubscribe-auth/BK7ODR6VHZTV5UTCKATSAG3Z6SZDJAVCNFSM6AAAAABRBJ6IR6VHI2DSMVQWIX3LMV43OSLTON2WKQ3PNVWWK3TUHMZDINJSHE2TSMRUGQ> . You are receiving this because you were assigned.Message ID: ***@***.***>