Skip to content

📑: Interactive Demo #67

Description

@Tejasri-T

🔍 Have You Searched Existing Issues?

[✓] I have searched the existing issues to avoid duplicates

💡 Problem Description

New users or contributors may find it hard to understand how to navigate Menthub or use its features. Without a visual guide, onboarding can be slow, and first impressions may suffer.

✅ Proposed Solution

Add an Interactive Demo / Visual Guide Section:

Include screenshots or GIFs for key workflows:

Signing up as a mentor or mentee

Profile completion

Requesting mentorship sessions

Browsing mentor/mentee listings

Using the ML-based matching system

Optionally, create short tutorial videos embedded in the README or a dedicated “Demo” page.

Could include step-by-step captions explaining each action in the UI.

Make the visuals lightweight so the repository size is not affected (use optimized GIFs or hosted videos).

Tech Implementation Suggestion:

Store GIFs/screenshots in /static/demo folder.

Add a README section or dedicated “How to Use Menthub” page linking to the visuals.

Optionally, use GitHub Pages or embedded Loom videos for interactive walkthroughs.

🔄 Alternatives Considered

Text-only instructions: Less engaging and harder for new users to follow.

External documentation: Users may not check it regularly; integration in the repo is better.

📘 Additional Context

Improves user onboarding and engagement.

Helps new contributors understand the app quickly, reducing confusion when contributing.

Can be combined with existing documentation improvements to make the repo more attractive.

🙌 Contributor Checklist

[✓] I have checked for similar feature requests

[✓] I agree to follow this project's Code of Conduct

[✓] I am a GSSOC'25 contributor

[✓] I want to work on this issue

Metadata

Metadata

Assignees

No one assigned

    Labels

    No labels
    No labels

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions