Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

📃 Documentation Update: Adding a Project Structure Map #164

Open
siri-chandana-macha opened this issue Nov 2, 2024 · 1 comment
Open

Comments

@siri-chandana-macha
Copy link

Describe the documentation update.

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

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

Why is this needed?

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

Additional context

Note: please kindly assign this issue under gssoc-extd and hacktoberfest-accepted and level

Copy link

github-actions bot commented Nov 2, 2024

👋 Thanks for opening this issue! We appreciate your contribution. Please make sure you’ve provided all the necessary details and screenshots, and don't forget to follow our Guidelines and Code of Conduct. Happy coding! 🚀

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

No branches or pull requests

1 participant