[Doc]: Adding a Project Structure Map in the Documentation #373
Description
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)