OpenAdaptAI / OpenAdapt

Open Source Generative Process Automation (i.e. Generative RPA). AI-First Process Automation with Large ([Language (LLMs) / Action (LAMs) / Multimodal (LMMs)] / Visual Language (VLMs)) Models
https://www.OpenAdapt.AI
MIT License
881 stars 115 forks source link

Add onboarding for new users #746

Closed KIRA009 closed 3 months ago

KIRA009 commented 3 months ago

What kind of change does this PR introduce?

This PR introduces an onboarding mechanism to the dashboard.

Summary This PR introduces a change where the dashboard is launched by default when the app is launched. The dashboard also displays an onboarding modal, which the user can dismiss and it won't pop up again. The modal contains an input box to capture the email of the user if they wan't to receive regular updates about OpenAdapt. It also contains a link that can be used to schedule a short meeting with @abrichr

This PR address #711

Checklist

How can your code be run and tested? Run the app as usual python -m openadapt.entrypoint. The dashboard should launch by default, and you should see an onboarding form. Closing the modal (by clicking on X or outside the modal) or set a config variable to false, and the modal will not be shown again on subsequent page visits.

Other information

KIRA009 commented 3 months ago

@abrichr Based on what you said, I think what we could do is, increase the size of the modal, use a component like https://mantine.dev/core/stepper/ to clearly divide the onboarding to steps

  1. How to use OpenAdapt
  2. Register for updates
  3. Book a call

And then, for the first step, what do you think about embedding a video recording (like a demo) hosted on youtube (or any other video platform, vimeo ,etc.) I think a video demo would be more engaging that a series of screenshots and texts

abrichr commented 3 months ago

Sounds great! If possible it would be preferable to keep everything visible, e.g. with an accordion, so as to reduce friction as much as possible.

@KIRA009 can you please also document python -m openadapt.entrypoint in the README?

KIRA009 commented 3 months ago

@abrichr I have used the demo video from openadapt.ai as the first step of onboarding. Also, if you want to view the onboarding again, please change SHOW_ONBOARDING_MODAL in your config.json to true

abrichr commented 3 months ago

@KIRA009

If possible it would be preferable to keep everything visible, e.g. with an accordion, so as to reduce friction as much as possible.

I think the stepper adds unnecessary friction. How about just using the Divider from mantine?

KIRA009 commented 3 months ago

@abrichr I have updated it, with the dividers

abrichr commented 3 months ago

@KIRA009 I don't see the changes, have you pushed them?

KIRA009 commented 3 months ago

@abrichr Pushed

abrichr commented 3 months ago

Thank you. It looks like the content overflows the modal:

image

Can you please make sure the content isn't overflowing? Or how about instead of a modal we just push them to an /onboarding page?

Also please add this sentence:

Welcome to OpenAdapt! Thank you for joining us on our mission to build open source desktop AI. Your feedback is extremely valuable!

To start, please watch the demonstration below. Then try it yourself!

If you'd like to contribute directly to our development, please consider the following open Bounties (no development experience required):

Here, place a bounty card (see https://github.com/algora-io/sdk) for https://github.com/OpenAdaptAI/OpenAdapt/issues/764.

Also, please replace the <video> tag with the embedded Youtube version: https://www.youtube.com/watch?v=OVERugs50cQ

KIRA009 commented 3 months ago

@abrichr Updated

abrichr commented 3 months ago

@KIRA009 getting there! Some thoughts:

To start, please watch the demonstration below. Then try it yourself!

To this:

To start, please watch the demonstration below. Then try it yourself! If you have any issues, please submit a Github Issue.

If you'd like to contribute directly to our development, please consider the following open Bounties (no development experience required):

KIRA009 commented 3 months ago

Updated

image