Skip to content

Improve Project Documentation & Contributor Onboarding #355

Closed

Description

@Nitya-003

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! 🚀

Activity

  1. github-actions commented on Dec 13, 2025

    @github-actions

    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.

  2. Avdhesh-Varshney commented on Dec 14, 2025

    @Avdhesh-Varshney
    Collaborator

    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

    Plz refer github wiki of this repo

  3. moved this from up-for-grabs to assigned in OS - TASK TRACKERon Dec 14, 2025
  4. Avdhesh-Varshney commented on Dec 14, 2025

    @Avdhesh-Varshney
    Collaborator

    Please also refer the README of https://github.com/Code-A2Z/code-a2z

  5. Nitya-003 commented on Dec 15, 2025

    @Nitya-003
    Author

    Ok I will refer

  6. Nitya-003 commented on Dec 19, 2025

    @Nitya-003
    Author

    @Avdhesh-Varshney Close the issue...and merge PR.

  7. Nitya-003 commented on Feb 3, 2026

    @Nitya-003
    Author
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Metadata

Metadata

Assignees

Labels

documentationImprovements or additions to documentation

Type

Projects

Milestone

No milestone

Relationships

None yet

Development

No branches or pull requests

Issue actions