gitbutler icon indicating copy to clipboard operation
gitbutler copied to clipboard

App onboarding

Open PavelLaptev opened this issue 6 months ago • 1 comments

There was a discussion about improving the onboarding process. Currently, when you start, there’s no guidance provided; instead, you have a link to the documentation.


Solution

As we discussed on Discord, the onboarding process could include the following:

Modal or Split-Screen with Slides

In these slides, we can briefly explain how GitButler works and general principles:

  1. Start with a short onboarding process featuring 2-3 slides when the user first opens the app.
  2. The last slide should offer an option to 'Create Demo Repo,' allowing the user to try things out without worrying about mistakes.
  3. If the user skips creating the demo repo, they go straight to the main screen.
  4. In Design 3.0, some areas stay empty until the user performs certain actions. We can use these spots to display quick tips.
  5. The onboarding process (including the demo repo creation) should also be accessible again from the top-bar menu.

Demo Repo To-Do List and Feature Highlights

Before allowing the user to explore the app on their own, we can introduce general actions through a to-do list of tasks to help them understand the GitButler workflow.

Here are some tasks we can guide the user through:

  • Committing changes
  • Pushing changes
  • Working with multiple branches
  • Reordering commits and moving files
  • Applying/unapplying branches
  • [another task]
  • Creating and merging a PR as the final step

Here’s the Discord discussion: https://discord.com/channels/1060193121130000425/1073202153163857920/1275825080613605386

PavelLaptev avatar Aug 22 '24 08:08 PavelLaptev