You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
{{ message }}
Repository navigation
Add Project Structure Documentation to README #346
The README.md currently lacks a clear project structure section that shows the organization of files and directories. This makes it difficult for new contributors to understand where different components are located and how the project is organized.
Proposed Solution
Add a comprehensive "Project Structure" section to the README.md that visualizes the directory tree and explains the purpose of each major folder/file.
Acceptance Criteria
Add a "📁 Project Structure" section in README.md (preferably after Features and before Contributing)
Include a visual directory tree showing main folders and key files
Add brief descriptions for each major directory/component
Use proper markdown formatting with code blocks
Ensure the structure matches the actual repository organization
Keep it concise but informative (not every single file, just important ones)
Thank you for creating this issue! We'll look into it as soon as possible. Your contributions are highly appreciated! 😊
For further communication, join our discord server https://discord.gg/tSqtvHUJzE.
Activity
github-actions commentedon Oct 26, 2025
Thank you for creating this issue! We'll look into it as soon as possible. Your contributions are highly appreciated! 😊
For further communication, join our discord server https://discord.gg/tSqtvHUJzE.
Avdhesh-Varshney commentedon Oct 26, 2025
For this @Venkatkalyan21, You have to first contribute something meaningful in this project.
So to aware about the project properly.
Venkatkalyan21 commentedon Oct 27, 2025
I actually raised an issue for improving the README — just wanted to start by understanding the project better before contributing further.
Avdhesh-Varshney commentedon Oct 27, 2025
Yes, But for this contribution, You have to contribute something in codebase.
Om7035 commentedon Oct 27, 2025
should i work on it?
docs: add comprehensive project structure documentation to README