Skip to content
Snippets Groups Projects
Normal view Permalink
onboarding.md 1.05 KiB
Newer Older
  • Learn to ignore specific revisions
    • Bastien DUMONT's avatar
    refactor docs  
    Bastien DUMONT committed
    1 2 
    # Onboarding
    Yoan VALLET's avatar
    feat: add onboarding section
    Yoan VALLET committed
    3 4 5 6 7 
    This section explains the way we handle onboarding the application.

## Description

When the user connects for the first time to Ecolyo, onboarding screens will be displayed.
    Bastien DUMONT's avatar
    refactor docs  
    Bastien DUMONT committed
    8 
    !!! note "First connection"
    Yoan VALLET's avatar
    feat: add onboarding section
    Yoan VALLET committed
    9 10 11 12 
        The first connection is define by the **isFirstConnection** boolean contains in the **profile** doctype.

### GCU screen
    Hugo NOUTS's avatar
    fix typos  
    Hugo NOUTS committed
    13 
    First of all, we display the GCU screen, which allows user to read the General Condition of Use and the Legal Notice. The user should consent to all the terms to go further in the application.
    Bastien DUMONT's avatar
    refactor docs  
    Bastien DUMONT committed
    14 
    !!! note "About terms"
    Rémi PAILHAREY's avatar
    fix: broken links not ending by slash  
    Rémi PAILHAREY committed
    15 
        More details are available on the [term section](/ecolyo/functionalities/terms/).
    Yoan VALLET's avatar
    feat: add onboarding section
    Yoan VALLET committed
    16 17 18 19 20 21 22 
    
### Welcome modal

After GCU screen we display a welcome modal to inform user about further steps needed to use Ecolyo (connection to partners to retrieve the data, ...).
We store in user's profile a boolean _onboarding.isWelcomeSeen_ that allows the app to know is the modal has already be seen. If the modal has been seen we will never display it again.

When user close this modal, the **welcome mail** is sent to the user.