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
Description:
Jarvis is an impressive AI-based virtual assistant with features like automation, role-based access, and Streamlit authentication. However, for new contributors and first-time users, understanding the project structure and getting started can be a bit confusing.
The repository contains many powerful ideas (AI models, automation, admin tools, auth, etc.), but clearer documentation and onboarding guidance would make it much easier for contributors to start contributing confidently.
Suggested Improvements:
Add a clear “Getting Started” section with setup steps and dependencies
Provide a project architecture overview explaining modules like automation, auth, admin tools, and AI models
Include example commands or use cases for Jarvis (voice/text)
Clarify contribution guidelines and PR expectations with examples
Add screenshots or a short demo of the Streamlit UI & authentication flow
Why this matters:
Better documentation will help beginners, open-source contributors, and program participants (GSSoC, Hacktoberfest, IWOC, etc.) understand the project faster and contribute more effectively.
Thank you for maintaining such a helpful open-source project and supporting the contributor community! 🚀
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.
Hi @Nitya-003
Thanks for raising this issue! Plz properly gone through the repo code and functionality before writing the readme file
For any confusion or discussion, connect me on discord or github discussion
Activity
github-actions commentedon Dec 13, 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 Dec 14, 2025
Hi @Nitya-003
Thanks for raising this issue! Plz properly gone through the repo code and functionality before writing the readme file
For any confusion or discussion, connect me on discord or github discussion
Avdhesh-Varshney commentedon Dec 14, 2025
Please also refer the README of https://github.com/Code-A2Z/code-a2z
Nitya-003 commentedon Dec 15, 2025
Ok I will refer
Nitya-003 commentedon Dec 19, 2025
@Avdhesh-Varshney Close the issue...and merge PR.
Nitya-003 commentedon Feb 3, 2026
@Avdhesh-Varshney ..