Merge pull request #117 from wwt/jazzy-restructure

GitHub io documentation restructured.

Author: Tyler-Keith-Thompson

.github/.jazzy.yaml

@@ -11,31 +11,34 @@ author: WWT and Tyler Thompson
 documentation: .github/guides/*.md
 abstract: .github/abstract/*.md
 custom_categories:
-- name: How to use SwiftCurrent with SwiftUI
-  children:
-    - Getting Started with SwiftUI
-    - Working with NavigationView
-- name: How to use SwiftCurrent with UIKit
+- name: Overview
   children:
-    - Storyboards Intro
-    - Programmatic UIKit Intro
+    - Why This Library
+    - Installation
 - name: Creating Workflows
   children:
     - FlowRepresentable
-    - PassthroughFlowRepresentable
     - Workflow
+    - PassthroughFlowRepresentable
+- name: How to use SwiftCurrent with SwiftUI
+  children:
+    - Getting Started with SwiftUI
+    - Working with NavigationView
 - name: Creating Workflows in SwiftUI
   children:
+    - WorkflowLauncher
     - View
-    - ViewControllerWrapper
     - WorkflowItem
-    - WorkflowLauncher
+- name: How to use SwiftCurrent with UIKit
+  children:
+    - Using Programmatic Views
+    - Using Storyboards
 - name: Creating Workflows in UIKit
   children:
-    - HostedWorkflowItem
-    - StoryboardLoadable
     - UIViewController
     - UIWorkflowItem
+    - HostedWorkflowItem
+    - StoryboardLoadable
 - name: Controlling Presentation
   children:
     - LaunchStyle
@@ -47,7 +50,8 @@ custom_categories:
     - AnyFlowRepresentable
 - name: Underlying Types
   children:
+    - FlowRepresentableMetadata
     - LinkedList
-    - WorkflowError
     - OrchestrationResponder
-    - FlowRepresentableMetadata
+    - ViewControllerWrapper
+    - WorkflowError

.github/wiki/UPGRADE_PATH.md renamed to .github/UPGRADE_PATH.md

@@ -4,11 +4,11 @@ This guide will walk you through getting a `Workflow` up and running in a new iO
 
 The app in this guide is going to be very simple.  It consists of a view that will host the `WorkflowLauncher`, a view to enter an email address, and an optional view for when the user enters an email with `@wwt.com` in it.  Here is a preview of what the app will look like:
 
-![Preview image of app](https://raw.githubusercontent.com/wwt/SwiftCurrent/main/.github/wiki/swiftUI.gif)
+![Preview image of app](https://user-images.githubusercontent.com/79471462/131556533-f2ad1e6c-9acd-4d62-94ac-9140c9718f95.gif)
 
 ## Adding the dependency
 
-For instructions on SPM and CocoaPods, [check out our installation page.](https://github.com/wwt/SwiftCurrent/wiki/Installation#swift-package-manager)
+For instructions on SPM and CocoaPods, [check out our installation page.](installation.html#swift-package-manager)
 
 ## IMPORTANT NOTE
 
@@ -18,6 +18,8 @@ SwiftCurrent is so convenient that you may miss the couple lines that are calls
 
 Create two views that implement `FlowRepresentable`.
 
+First view:
+
 ```swift
 import SwiftUI
 import SwiftCurrent
@@ -48,6 +50,13 @@ struct FirstView_Previews: PreviewProvider {
         FirstView(with: "Example Name")
     }
 }
+```
+
+Second view:
+
+```swift
+import SwiftUI
+import SwiftCurrent
 
 struct SecondView: View, FlowRepresentable { // SwiftCurrent
     typealias WorkflowOutput = String // SwiftCurrent
@@ -201,4 +210,4 @@ WorkflowLauncher(isLaunched: $workflowIsPresented) { // SwiftCurrent
         thenProceed(with: SecondView.self) // SwiftCurrent
     }
 }
-```
+```

.github/guides/Getting Started with SwiftUI.md

@@ -4,11 +4,11 @@ This guide will walk you through getting a `Workflow` up and running in a new iO
 
 The app in this guide is going to be very simple.  It consists of a screen that will launch the `Workflow`, a screen to enter an email address, and an optional screen for when the user enters an email with `@wwt.com` in it.  Here is a preview of what the app will look like:
 
-![Preview image of app](https://raw.githubusercontent.com/wwt/SwiftCurrent/main/.github/wiki/programmatic.gif)
+![Preview image of app](https://user-images.githubusercontent.com/79471462/131556322-56757c1d-e4ec-4581-a47c-969f536e3893.gif)
 
 ## Adding the dependency
 
-For instructions on SPM and CocoaPods, [check out our installation page.](https://github.com/wwt/SwiftCurrent/wiki/Installation#swift-package-manager)
+For instructions on SPM and CocoaPods, [check out our installation page.](installation.html#swift-package-manager)
 
 ## IMPORTANT NOTE
 
@@ -18,6 +18,8 @@ SwiftCurrent is so convenient that you may miss the couple lines that are calls
 
 Create two view controllers that inherit from `UIWorkflowItem` and implement `FlowRepresentable`.
 
+First view controller:
+
 ```swift
 import UIKit
 import SwiftCurrent
@@ -72,6 +74,14 @@ class FirstViewController: UIWorkflowItem<String, String>, FlowRepresentable { /
         saveButton.topAnchor.constraint(equalTo: emailTextField.bottomAnchor, constant: 24).isActive = true
     }
 }
+```
+
+Second view controller:
+
+```swift
+import UIKit
+import SwiftCurrent
+import SwiftCurrent_UIKit
 
 // This screen shows an employee only screen
 class SecondViewController: UIWorkflowItem<String, String>, FlowRepresentable { // SwiftCurrent
@@ -280,4 +290,4 @@ Now in your UIKit workflow simply use a `HostedWorkflowItem` (While in BETA, `im
 
 ```swift
 launchInto(Workflow(HostedWorkflowItem<SwiftUIView>.self)) // SwiftCurrent
-```
+```

.github/wiki/Installation.md renamed to .github/guides/Installation.md

@@ -4,11 +4,11 @@ This guide will walk you through getting a `Workflow` up and running in a new iO
 
 The app in this guide is going to be very simple.  It consists of a screen that will launch the `Workflow`, a screen to enter an email address, and an optional screen for when the user enters an email with `@wwt.com` in it.  Here is a preview of what the app will look like:
 
-![Preview image of app](https://raw.githubusercontent.com/wwt/SwiftCurrent/main/.github/wiki/storyboard.gif)
+![Preview image of app](https://user-images.githubusercontent.com/79471462/131556008-943f5e00-b7d0-4782-974d-1e914c4179fc.gif)
 
 ## Adding the dependency
 
-For instructions on SPM and CocoaPods, [check out our installation page.](https://github.com/wwt/SwiftCurrent/wiki/Installation#swift-package-manager)
+For instructions on SPM and CocoaPods, [check out our installation page.](installation.html#swift-package-manager)
 
 ## IMPORTANT NOTE
 
@@ -39,6 +39,8 @@ extension MainStoryboardLoadable {
 
 Create two view controllers that both conform to `MainStoryboardLoadable` and inherit from `UIWorkflowItem`.
 
+First view controller:
+
 ```swift
 import UIKit
 import SwiftCurrent_UIKit
@@ -64,6 +66,13 @@ class FirstViewController: UIWorkflowItem<String, String>, MainStoryboardLoadabl
         proceedInWorkflow(emailTextField.text ?? "") // SwiftCurrent
     }
 }
+```
+
+Second view controller:
+
+```swift
+import UIKit
+import SwiftCurrent_UIKit
 
 // This screen shows an employee only screen
 class SecondViewController: UIWorkflowItem<String, String>, MainStoryboardLoadable { // SwiftCurrent
@@ -265,4 +274,4 @@ Now in your UIKit workflow simply use a `HostedWorkflowItem` (While in BETA, `im
 
 ```swift
 launchInto(Workflow(HostedWorkflowItem<SwiftUIView>.self)) // SwiftCurrent
-```
+```

.github/guides/Programmatic UIKit Intro.md renamed to .github/guides/Using Programmatic Views.md

@@ -1,7 +1,7 @@
 ### Why This Library?
 There are many reasons to be excited about SwiftCurrent:
 - Build flexibility into your applications so that you can easily make changes when you need to.
-- Compose new [Workflows](https://wwt.github.io/SwiftCurrent/Classes/Workflow.html) to quickly create a new journey through your app.
+- Compose new `Workflow`s to quickly create a new journey through your app.
 - Stop components in your app from knowing more than they should, no more complicated routers or views that have to know what comes next.
 - Create flows that give your users a better experience, web frameworks can easily sign somebody in, or sign them up, then continue into a flow, so why not be able to easily do the same in Swift?
 - Power deep linking experiences that can get your users right where you want them with minimal overhead.