From 77fdc514bff211a3e0a97f7934988b029972b9ef Mon Sep 17 00:00:00 2001
From: Johannes Millan <johannes.millan@gmail.com>
Date: Fri, 26 Jan 2024 16:12:51 +0100
Subject: [PATCH] feat(tour): add simple intro for projects

---
 .../core-ui/side-nav/side-nav.component.html  |  2 +-
 .../features/shepherd/shepherd-steps.const.ts | 47 ++++++++++++++++---
 src/app/features/shepherd/shepherd.service.ts |  2 +-
 src/styles/components/shepherd.scss           |  3 ++
 4 files changed, 46 insertions(+), 8 deletions(-)

diff --git a/src/app/core-ui/side-nav/side-nav.component.html b/src/app/core-ui/side-nav/side-nav.component.html
index 5b37f46619..93cd4ff6b7 100644
--- a/src/app/core-ui/side-nav/side-nav.component.html
+++ b/src/app/core-ui/side-nav/side-nav.component.html
@@ -73,7 +73,7 @@
 
 <section
   *ngIf="projectList$|async as projectList"
-  class="projects"
+  class="projects tour-projects"
 >
   <button
     #menuEntry
diff --git a/src/app/features/shepherd/shepherd-steps.const.ts b/src/app/features/shepherd/shepherd-steps.const.ts
index ec148f48d3..285ac56ab9 100644
--- a/src/app/features/shepherd/shepherd-steps.const.ts
+++ b/src/app/features/shepherd/shepherd-steps.const.ts
@@ -37,13 +37,12 @@ const CLICK_B = IS_MOUSE_PRIMARY ? '<em>Click</em>' : '<em>Tap</em>';
 
 export enum TourId {
   Welcome = 'Welcome',
-  AddTask = 'AddTask',
   DeleteTask = 'DeleteTask',
   Sync = 'Sync',
+  Projects = 'Projects',
   Calendars = 'Calendars',
   ProductivityHelper = 'ProductivityHelper',
   IssueProviders = 'IssueProviders',
-  Project = 'Project',
   FinishDay = 'FinishDay',
   StartTourAgain = 'StartTourAgain',
   KeyboardNav = 'KeyboardNav',
@@ -64,6 +63,7 @@ export const SHEPHERD_STEPS = (
     `<kbd>${cfg.keyboard[action]}</kbd>`;
 
   return [
+    // ------------------------------
     {
       id: TourId.Welcome,
       title: 'Welcome to Super Productivity!!',
@@ -71,7 +71,6 @@ export const SHEPHERD_STEPS = (
       buttons: [CANCEL_BTN(shepherdService), NEXT_BTN],
     },
     {
-      id: TourId.AddTask,
       title: "Let's add your first task!",
       text: IS_MOUSE_PRIMARY
         ? `<em>Click</em> on this button or press ${KEY_COMBO('addNewTask')}.`
@@ -245,6 +244,8 @@ export const SHEPHERD_STEPS = (
           },
         ]
       : []),
+
+    // ------------------------------
     {
       id: TourId.DeleteTask,
       title: 'Deleting a Task',
@@ -276,11 +277,38 @@ export const SHEPHERD_STEPS = (
         };
       })(),
     },
+
+    // ------------------------------
     {
-      title: 'Great job!',
-      text: 'That covers the basics. Let`s continue with another important subject: <strong>Syncing</strong>!',
+      id: TourId.Projects,
+      title: 'Projects',
+      text: 'You can create different task lists by using projects.',
       buttons: [NEXT_BTN],
     },
+    {
+      title: 'Projects',
+      attachTo: {
+        element: '.tour-burgerTrigger',
+        on: 'bottom',
+      },
+      text: 'Open the menu (<span class="material-icons">menu</span>)',
+      ...nextOnObs(
+        layoutService.isShowSideNav$.pipe(filter((v) => !!v)),
+        shepherdService,
+      ),
+    },
+    {
+      title: 'Projects',
+      attachTo: {
+        element: '.tour-projects',
+        on: 'bottom',
+      },
+      highlightClass: 'shepherd-highlight-inner',
+      text: '<p>Projects are also used to import tasks from issue providers like Jira, OpenProject, GitHub, GitLab, Redmine and Gitea.</p>',
+      buttons: [NEXT_BTN],
+    },
+
+    // ------------------------------
     {
       id: TourId.Sync,
       title: 'Syncing & Data Privacy',
@@ -298,6 +326,7 @@ export const SHEPHERD_STEPS = (
         element: '.tour-burgerTrigger',
         on: 'bottom',
       },
+      beforeShowPromise: () => router.navigate(['']),
       text: 'Open the menu (<span class="material-icons">menu</span>)',
       ...nextOnObs(
         layoutService.isShowSideNav$.pipe(filter((v) => !!v)),
@@ -315,7 +344,6 @@ export const SHEPHERD_STEPS = (
         ),
         shepherdService,
         // make sure we are not on config page already
-        () => router.navigate(['']),
       ),
     },
     {
@@ -353,6 +381,7 @@ export const SHEPHERD_STEPS = (
       buttons: [NEXT_BTN],
     },
 
+    // ------------------------------
     {
       id: TourId.Calendars,
       when: {
@@ -398,6 +427,7 @@ export const SHEPHERD_STEPS = (
       buttons: [NEXT_BTN],
     },
 
+    // ------------------------------
     {
       id: TourId.ProductivityHelper,
       when: {
@@ -421,6 +451,7 @@ export const SHEPHERD_STEPS = (
       buttons: [NEXT_BTN],
     },
 
+    // ------------------------------
     {
       id: TourId.FinalCongrats,
       title: 'Congratulations!',
@@ -446,6 +477,8 @@ export const SHEPHERD_STEPS = (
         } as any,
       ],
     },
+
+    // ------------------------------
     {
       id: TourId.StartTourAgain,
       title: 'Show again?',
@@ -476,6 +509,8 @@ export const SHEPHERD_STEPS = (
         } as any,
       ],
     },
+
+    // ------------------------------
     {
       id: TourId.KeyboardNav,
       title: 'Keyboard Navigation',
diff --git a/src/app/features/shepherd/shepherd.service.ts b/src/app/features/shepherd/shepherd.service.ts
index 4f11d07d69..bec43a9ef1 100644
--- a/src/app/features/shepherd/shepherd.service.ts
+++ b/src/app/features/shepherd/shepherd.service.ts
@@ -46,7 +46,7 @@ export class ShepherdService {
       ) as any,
     );
     this.start();
-    // this.show(TourId.XXX);
+    // this.show(TourId.Projects);
     // this.show(TourId.FinalCongrats);
   }
 
diff --git a/src/styles/components/shepherd.scss b/src/styles/components/shepherd.scss
index d0d405e0cc..ad5172ee3e 100644
--- a/src/styles/components/shepherd.scss
+++ b/src/styles/components/shepherd.scss
@@ -7,6 +7,9 @@
 .shepherd-highlight {
   outline: 3px solid $c-accent !important;
 }
+.shepherd-highlight-inner {
+  border: 3px solid $c-accent !important;
+}
 
 .shepherd-text kbd {
   background-color: #eee;