ESID icon indicating copy to clipboard operation
ESID copied to clipboard

Feature/onboarding

Open emilijadunoska opened this issue 1 year ago • 1 comments

Description

This PR is for the development of the Onboarding System for ESID that effectively guides new users through the application's features and helps them become familiar with it.

Related Issues

  • #370
  • #372
  • #373

Design Decisions

The onboarding system is developed with the React joyride library. There is also a welcome modal that is displayed during the user's initial visit which provides an overview of the application through a series of informative slides and illustrations. The onboarding tours are accessible through the information button in the top bar, which makes them available without being intrusive. Users have the flexibility to start, pause, or retake any tour at their own pace. This implementation makes the onboarding experience adaptable for both new and existing users.

Possible alternative implementations were considered, such as creating a one-time static tour that users would go through only during their first visit. However, this approach is less flexible and doesn't allow users to revisit the tours later or learn at their own pace.

Performance & Quality

Checklist

I, the author of this PR checked the following requirements for good software quality:

  • [ ] The code is properly formatted (I ran the formatter)
  • [ ] The code is written with our software quality standards (I ran the linter)
  • [ ] The code is written using our code style
  • [ ] Extensive in source documentation has been added
  • [ ] Unit and/or integration tests have been added
  • [ ] All texts have been internationalized with at least the following languages:
    • [ ] English
    • [ ] German
  • [ ] I tried addressing all new accessibility problems displayed in the console and documented if they can't be fixed
  • [ ] I attached performance measurements to prevent performance degradation
  • [ ] I added the changes to the next release section of the changelog

I, the reviewer checked the following things:

  • [ ] I ran the software once and tried all new and related functionality to this PR
  • [ ] I looked at all new and changed lines of code and commented on possible problems
  • [ ] I read the added documentation and checked if it is understandable and clear
  • [ ] I checked the added tests for completeness
  • [ ] I checked the internationalized strings for spelling errors
  • [ ] I checked the performance metrics for problems or unexplained degradation
  • [ ] I checked that the changes are noted in the changelog

emilijadunoska avatar Aug 02 '24 13:08 emilijadunoska

Test Results

104 tests  +35   104 :white_check_mark: +35   22s :stopwatch: +8s  38 suites + 9     0 :zzz: ± 0    1 files   ± 0     0 :x: ± 0 

Results for commit 432646e5. ± Comparison against base commit a71bc2c4.

:recycle: This comment has been updated with latest results.

github-actions[bot] avatar Aug 05 '24 14:08 github-actions[bot]

Looks very good. The code quality is very high.

Apart from the comments and suggestions I already made the only other change request would be to suggest, for you to write all comments with a capital letter at the start and if they form a sentence also with a period at the end.

Thank you for the positive feedback! I've addressed the comments and suggestions you made.

emilijadunoska avatar Sep 04 '24 09:09 emilijadunoska