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

DOC: Adding a Project Structure Map #147

Open
2 tasks done
siri-chandana-macha opened this issue Nov 2, 2024 · 0 comments
Open
2 tasks done

DOC: Adding a Project Structure Map #147

siri-chandana-macha opened this issue Nov 2, 2024 · 0 comments
Assignees

Comments

@siri-chandana-macha
Copy link

What's wrong with the existing documentation

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

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

Add ScreenShots

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

Record

  • I agree to follow this project's Code of Conduct
  • I want to work on this issue
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

2 participants