Skip to content

Commit 7b6471a

Browse files
authored
Merge pull request #1258 from square/ray/nav
Typos, broken links, fussing with top level org.
2 parents cda9468 + b09d63b commit 7b6471a

File tree

3 files changed

+13
-10
lines changed

3 files changed

+13
-10
lines changed

docs/userguide/concepts.md

+8-5
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,7 @@
1-
# Core Concepts
1+
# Workflow Core Concepts
2+
3+
This page provides a high level overview of Workflow Core, the UI-agnostic Swift and Kotlin runtimes at the heart of the Workflow libraries.
4+
See [Workflow UI Concepts](../ui-concepts) to learn about the companion Android and iOS specific modules.
25

36
## What is a Workflow?
47

@@ -18,8 +21,8 @@ For example, a Workflow running a simple game might be configured with a descrip
1821
![Workflow schematic with State type GameState, Props type Players, Rendering type GameScreen, and Output type GameOver. The workflow is receiving an onClick() event.](../images/game_workflow_schematic.svg)
1922

2023
A workflow Rendering usually serves as a view model in iOS or Android apps, but that is not a requirement.
21-
In fact, this page includes no details about how platform specific UI code is driven.
22-
See [Workflow UI](../ui-concepts) for that discussion.
24+
Again, this page includes no details about how platform specific UI code is driven.
25+
See [Workflow UI Concepts](../ui-concepts) for that discussion.
2326

2427
!!! note
2528
Readers with an Android background should note the lower case _v_ and _m_ of "view model" — this notion has nothing to do with Jetpack `ViewModel`.
@@ -85,9 +88,9 @@ WIP
8588

8689
## Why does Workflow work this way?
8790

88-
Worklow was built to tame the composition and navigation challenges presented by Square's massive Android and iOS apps.
91+
Workflow was built to tame the composition and navigation challenges presented by Square's massive Android and iOS apps.
8992
It lets us write intricate, centralized, well tested code encapsulating the flow through literally hundreds of individual screens.
90-
We are no longer unable to see the forest for the trees.
93+
These days we are able to see and shape the forest, despite all of the trees.
9194

9295
We built it with two core design principals in mind:
9396

docs/userguide/ui-concepts.md

+4-4
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
1-
# Workflow UI
1+
# Workflow UI Concepts
22

3-
This page provides a high level overview of Workflow UI, the companion that allows [Workflow Core](../core-workflow) to drive Android and iOS apps.
3+
This page provides a high level overview of Workflow UI, the companion that allows [Workflow Core](../concepts) to drive Android and iOS apps.
44

55
!!! warning Kotlin WIP
66
The `Screen` interface that is so central to this discussion has reached Kotlin very recently, via `v1.8.0-beta01`.
@@ -12,7 +12,7 @@ This page provides a high level overview of Workflow UI, the companion that allo
1212
## Separation of Concerns
1313

1414
Workflow maintains a rigid separation between its core runtime and its UI support.
15-
The [Workflow Core](../core-workflow) modules are strictly Swift and Kotlin, with no dependencies on any UI framework.
15+
The [Workflow Core](../concepts) modules are strictly Swift and Kotlin, with no dependencies on any UI framework.
1616
Dependencies on Android and iOS are restricted to the Workflow UI modules, as you would expect.
1717
This innate separation naturally puts developers on a path to avoid entangling view concerns with their app logic.
1818

@@ -26,7 +26,7 @@ The strict divide between Workflow UI and Workflow Core leads you to maintain th
2626

2727
## What's a Screen?
2828

29-
Most Workflow implementations produce `struct` / `data class` [renderings](../core-workflow#rendering) that can serve as view models.
29+
Most Workflow implementations produce `struct` / `data class` [renderings](../../glossary#rendering) that can serve as view models.
3030
Such a rendering provides enough data to paint a UI, and functions to be called in response to UI events.
3131

3232
These view model renderings implement the `Screen` [protocol](https://github.com/square/workflow-swift/blob/main/WorkflowUI/Sources/Screen/Screen.swift) / [interface](https://github.com/square/workflow-kotlin/blob/main/workflow-ui/core-common/src/main/java/com/squareup/workflow1/ui/Screen.kt) to advertise that this is their intended use.

mkdocs.yml

+1-1
Original file line numberDiff line numberDiff line change
@@ -89,10 +89,10 @@ nav:
8989
- 'Why Workflow?': 'userguide/whyworkflow.md'
9090
- 'User Guide':
9191
- 'Core Concepts': 'userguide/concepts.md'
92+
- 'UI Concepts (in progress)': 'userguide/ui-concepts.md'
9293
- 'Coding a Workflow': 'userguide/workflow-in-code.md'
9394
- 'Coding a Worker': 'userguide/worker-in-code.md'
9495
- 'Testing (TBD)': 'userguide/testing-concepts.md'
95-
- 'Workflow UI (in progress)': 'userguide/ui-concepts.md'
9696
- 'Common Patterns': 'userguide/common-patterns.md'
9797
- 'Implementation Notes': 'userguide/implementation.md'
9898
- 'Tutorials and Samples':

0 commit comments

Comments
 (0)