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 UPDATE: Adding a Project Structure Map #2608

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

DOC UPDATE: Adding a Project Structure Map #2608

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

Comments

@siri-chandana-macha
Copy link

Documentation Page

I want to add a new section for Project Structue
ans a hyperlink click here which will navigate to map of project structure

Description of Changes

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

Reason for Update

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

Screenshots/Logs

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

Additional Information

  • I have checked the documentation for accuracy
  • I am willing to help with this update
  • I can provide further clarification if needed
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! 🚀

Copy link

github-actions bot commented Nov 2, 2024

👋 Thank you for raising an issue! We appreciate your effort in helping us improve. Our FinVeda team will review it shortly. Stay tuned!

@siri-chandana-macha
Copy link
Author

Please add the labels gssoc-ext and level

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

No branches or pull requests

1 participant