Clean up DocC and link to new migration guide in README (#3153)

* Clean up DocC and link to new migration guide in README * wip
pointfreeco · Jun 6, 2024 · 52ee2bb · 52ee2bb
1 parent 1eeca17
commit 52ee2bb
Show file tree

Hide file tree

Showing 12 changed files with 54 additions and 3 deletions.
diff --git a/README.md b/README.md
@@ -532,13 +532,14 @@ advanced usages.
 The documentation for releases and `main` are available here:
 
 * [`main`](https://pointfreeco.github.io/swift-composable-architecture/main/documentation/composablearchitecture/)
-* [1.10.0](https://pointfreeco.github.io/swift-composable-architecture/1.10.0/documentation/composablearchitecture/) ([migration guide](https://pointfreeco.github.io/swift-composable-architecture/main/documentation/composablearchitecture/migratingto1.10))
+* [1.11.0](https://pointfreeco.github.io/swift-composable-architecture/1.11.0/documentation/composablearchitecture/) ([migration guide](https://pointfreeco.github.io/swift-composable-architecture/main/documentation/composablearchitecture/migratingto1.11))
 
 <details>
   <summary>
   Other versions
   </summary>
 
+  * [1.10.0](https://pointfreeco.github.io/swift-composable-architecture/1.10.0/documentation/composablearchitecture/) ([migration guide](https://pointfreeco.github.io/swift-composable-architecture/main/documentation/composablearchitecture/migratingto1.10))
   * [1.9.0](https://pointfreeco.github.io/swift-composable-architecture/1.9.0/documentation/composablearchitecture/) ([migration guide](https://pointfreeco.github.io/swift-composable-architecture/main/documentation/composablearchitecture/migratingto1.9))
   * [1.8.0](https://pointfreeco.github.io/swift-composable-architecture/1.8.0/documentation/composablearchitecture/) ([migration guide](https://pointfreeco.github.io/swift-composable-architecture/main/documentation/composablearchitecture/migratingto1.8))
   * [1.7.0](https://pointfreeco.github.io/swift-composable-architecture/1.7.0/documentation/composablearchitecture/) ([migration guide](https://pointfreeco.github.io/swift-composable-architecture/main/documentation/composablearchitecture/migratingto1.7))

diff --git a/Sources/ComposableArchitecture/Documentation.docc/Articles/MigrationGuides.md b/Sources/ComposableArchitecture/Documentation.docc/Articles/MigrationGuides.md
@@ -14,6 +14,7 @@ APIs, and these guides contain tips to do so.
 
 ## Topics
 
+- <doc:MigratingTo1.11>
 - <doc:MigratingTo1.10>
 - <doc:MigratingTo1.9>
 - <doc:MigratingTo1.8>

diff --git a/...ticles/MigrationGuides/MigrationTo1.11.md → ...ticles/MigrationGuides/MigratingTo1.11.md b/...ticles/MigrationGuides/MigrationTo1.11.md → ...ticles/MigrationGuides/MigratingTo1.11.md
diff --git a/Sources/ComposableArchitecture/Documentation.docc/Extensions/AppStorageKey.md b/Sources/ComposableArchitecture/Documentation.docc/Extensions/AppStorageKey.md
@@ -28,3 +28,7 @@
 
 - ``PersistenceReaderKey/appStorage(_:)-5jsie``
 - ``AppStorageKeyPathKey``
+
+### Overriding app storage
+
+- ``Dependencies/DependencyValues/defaultAppStorage``
diff --git a/Sources/ComposableArchitecture/Documentation.docc/Extensions/FileStorageKey.md b/Sources/ComposableArchitecture/Documentation.docc/Extensions/FileStorageKey.md
@@ -8,6 +8,7 @@
 
 ### Overriding storage
 
+- ``Dependencies/DependencyValues/defaultFileStorage``
 - ``FileStorage``
 
 ### Deprecations

diff --git a/Sources/ComposableArchitecture/Documentation.docc/Extensions/InMemoryKey.md b/Sources/ComposableArchitecture/Documentation.docc/Extensions/InMemoryKey.md
@@ -8,4 +8,5 @@
 
 ### Overriding storage
 
+- ``Dependencies/DependencyValues/defaultInMemoryStorage``
 - ``InMemoryStorage``
diff --git a/Sources/ComposableArchitecture/Documentation.docc/Extensions/Reducer.md b/Sources/ComposableArchitecture/Documentation.docc/Extensions/Reducer.md
@@ -33,6 +33,7 @@
 
 - ``EmptyReducer``
 - ``BindingReducer``
+- ``Swift/Optional``
 
 ### Reducer modifiers
 

diff --git a/Sources/ComposableArchitecture/Documentation.docc/Extensions/Store.md b/Sources/ComposableArchitecture/Documentation.docc/Extensions/Store.md
@@ -29,8 +29,7 @@
 
 ### Scoping store bindings
 
-- ``SwiftUI/Binding/scope(state:action:fileID:line:)``
-- ``SwiftUI/Binding/scope(state:action:)-35r82``
+- ``SwiftUI/Binding``
 
 ### Combine integration
 

diff --git a/Sources/ComposableArchitecture/Documentation.docc/Extensions/SwiftUIBinding.md b/Sources/ComposableArchitecture/Documentation.docc/Extensions/SwiftUIBinding.md
@@ -0,0 +1,19 @@
+# ``SwiftUI/Binding``
+
+Learn how SwiftUI's `Binding` type has been extended for the Composable Architecture
+
+## Overview
+
+A binding to a ``Store``is extended with several unique scoping operations that can be used to power
+controls and drive navigation.
+
+## Topics
+
+### Control bindings
+
+- ``SwiftUI/Binding/subscript(dynamicMember:)``
+
+### Navigation bindings
+
+- ``SwiftUI/Binding/scope(state:action:fileID:line:)``
+- ``SwiftUI/Binding/scope(state:action:)-35r82``
diff --git a/...posableArchitecture/Documentation.docc/Extensions/SwiftUIBindingScopeForEach.md b/...posableArchitecture/Documentation.docc/Extensions/SwiftUIBindingScopeForEach.md
@@ -0,0 +1,8 @@
+# ``SwiftUI/Binding/scope(state:action:)-35r82``
+
+## Topics
+
+### Bindable
+
+- ``SwiftUI/Bindable/scope(state:action:)``
+- ``Perception/Bindable/scope(state:action:)``
diff --git a/...omposableArchitecture/Documentation.docc/Extensions/SwiftUIBindingScopeIfLet.md b/...omposableArchitecture/Documentation.docc/Extensions/SwiftUIBindingScopeIfLet.md
@@ -0,0 +1,8 @@
+# ``SwiftUI/Binding/scope(state:action:fileID:line:)``
+
+## Topics
+
+### Bindable
+
+- ``SwiftUI/Bindable/scope(state:action:fileID:line:)``
+- ``Perception/Bindable/scope(state:action:fileID:line:)``
diff --git a/...ComposableArchitecture/Documentation.docc/Extensions/SwiftUIBindingSubscript.md b/...ComposableArchitecture/Documentation.docc/Extensions/SwiftUIBindingSubscript.md
@@ -0,0 +1,8 @@
+# ``SwiftUI/Binding/subscript(dynamicMember:)``
+
+## Topics
+
+### Bindable
+
+- ``SwiftUI/Bindable/subscript(dynamicMember:)``
+- ``Perception/Bindable/subscript(dynamicMember:)``