docs(tutorials): create a basic tutorial on how to setup QuickActionsKit

Author: mlbonniec

Sources/QuickActionsKit/QuickActionsKit.docc/Configuration/Defining-Your-QuickActions.tutorial

@@ -0,0 +1,35 @@
+@Tutorial(time: 10) {
+    @Intro(title: "Defining your QuickActions") {
+        Learn how to configure the QuickActionsKit library to enhance your application's shortcuts.
+    }
+
+    @Section(title: "Define your application's Quick Actions") {
+        We'll first start by defining all the possible Quick Actions that your application is gonna 
+        
+        @Steps {
+            @Step {
+                First, start by creating an enum corresponding to your quick actions. This enum must conform to `String` and `QuickActionType`.
+                
+                @Code(name: "MyQuickActions.swift", file: Step1.swift)
+            }
+            
+            @Step {
+                Create a class conforming to `QuickActionsManager`, and define the `actions` property, that contains all your actions.
+                
+                @Code(name: "MyQuickActions.swift", file: Step2.swift)
+            }
+                        
+            @Step {
+                Specify actions availability. You can restrict visibility depending on the user authentication, current date etc.
+                
+                @Code(name: "MyQuickActions.swift", file: Step3.swift)
+            }
+            
+            @Step {
+                Create the `perform` method, that'll be called with the corresponding type and user information.
+                
+                @Code(name: "MyQuickActions.swift", file: Step4.swift)
+            }
+        }
+    }
+}

Sources/QuickActionsKit/QuickActionsKit.docc/Configuration/Step1.swift

@@ -0,0 +1,6 @@
+import QuickActionsKit
+
+enum MyQuickActionsType: String, QuickActionType {
+    case home
+    case editor
+}

Sources/QuickActionsKit/QuickActionsKit.docc/Configuration/Step2.swift

@@ -0,0 +1,17 @@
+import QuickActionsKit
+
+enum MyQuickActionsType: String, QuickActionType {
+    case home
+    case editor
+}
+
+class MyQuickActions: QuickActions {
+    var actions: Set<QuickActionsItem<MyQuickActionsType>> = [
+        QuickActionsItem<MyQuickActionsType>(
+            type: .home,
+            title: "Go Home",
+            subtitle: "Redirect to Home",
+            icon: nil
+        )
+    ]
+}

Sources/QuickActionsKit/QuickActionsKit.docc/Configuration/Step3.swift

@@ -0,0 +1,24 @@
+import QuickActionsKit
+
+enum MyQuickActionsType: String, QuickActionType {
+    case home
+    case editor
+}
+
+class MyQuickActions: QuickActions {
+    var actions: Set<QuickActionsItem<MyQuickActionsType>> = [
+        QuickActionsItem<MyQuickActionsType>(
+            type: .home,
+            title: "Go Home",
+            subtitle: "Redirect to Home",
+            icon: nil
+        ),
+        QuickActionsItem<MyQuickActionsType>(
+            type: .home,
+            title: "Edit",
+            subtitle: nil,
+            icon: nil,
+            isAvailable: MyApplicationSingleton.current.isUserLogged
+        )
+    ]
+}

Sources/QuickActionsKit/QuickActionsKit.docc/Configuration/Step4.swift

@@ -0,0 +1,34 @@
+import QuickActionsKit
+
+enum MyQuickActionsType: String, QuickActionType {
+    case home
+    case editor
+}
+
+class MyQuickActions: QuickActions {
+    var actions: Set<QuickActionsItem<MyQuickActionsType>> = [
+        QuickActionsItem<MyQuickActionsType>(
+            type: .home,
+            title: "Go Home",
+            subtitle: "Redirect to Home",
+            icon: nil
+        ),
+        QuickActionsItem<MyQuickActionsType>(
+            type: .home,
+            title: "Edit",
+            subtitle: nil,
+            icon: nil,
+            isAvailable: MyApplicationSingleton.current.isUserLogged
+        )
+    ]
+
+    func perform(for type: MyQuickActionsType, with userInfo: [String:NSSecureCoding]?) -> Bool {
+        switch type {
+        case .home:
+            print("Navigate to Home")
+
+        case .editor:
+            print("Navigate to the editor")
+        }
+    }
+}

Sources/QuickActionsKit/QuickActionsKit.docc/QuickActionsKit.md

@@ -0,0 +1,16 @@
+# ``QuickActionsKit``
+
+A lightweight library, allowing you to easily configure shortcuts (Quick Actions) from the Home Screen.
+
+## Overview
+
+This library can be used in both SwiftUI and UIKit architectures.
+Simply define your quick actions based on the current state of the application.
+
+![Cover](Cover.png)
+
+## Tutorials
+
+- <doc:Defining-Your-QuickActions>
+- <doc:Setup-QuickActions-for-SwiftUI>
+- <doc:Setup-QuickActions-for-UIKit>

Sources/QuickActionsKit/QuickActionsKit.docc/Resources/Cover.png

@@ -0,0 +1,5 @@
+@Tutorial(time: 10) {
+    @Intro(title: "Setup QuickActions for SwiftUI") {
+        Learn how to configure the QuickActionsKit library to enhance your application's shortcuts.
+    }
+}

Sources/QuickActionsKit/QuickActionsKit.docc/Setup/Setup-QuickActions-for-SwiftUI.tutorial

@@ -0,0 +1,5 @@
+@Tutorial(time: 10) {
+    @Intro(title: "Setup QuickActions for UIKit") {
+        Learn how to configure the QuickActionsKit library to enhance your application's shortcuts.
+    }
+}

Sources/QuickActionsKit/QuickActionsKit.docc/Setup/Setup-QuickActions-for-UIKit.tutorial

@@ -0,0 +1,21 @@
+@Tutorials(name: "QuickActionsKit Tutorials") {
+    @Intro(title: "Learn how to setup QuickActions for your application.") {
+        Add engaging introduction text here.
+        
+        @Image(source: Cover, alt: "Cover")
+    }
+    
+
+    @Chapter(name: "Configuration") {
+        @TutorialReference(tutorial: "doc:Defining-Your-QuickActions")
+        
+        @Image(source: Cover, alt: "Cover")
+    }
+    
+    @Chapter(name: "Setup") {
+        @TutorialReference(tutorial: "doc:Setup-QuickActions-for-SwiftUI")
+        @TutorialReference(tutorial: "doc:Setup-QuickActions-for-UIKit")
+        
+        @Image(source: Cover, alt: "Cover")
+    }
+}