Skip to content

Commit 52ee2bb

Browse files
authored
Clean up DocC and link to new migration guide in README (#3153)
* Clean up DocC and link to new migration guide in README * wip
1 parent 1eeca17 commit 52ee2bb

File tree

12 files changed

+54
-3
lines changed

12 files changed

+54
-3
lines changed

README.md

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -532,13 +532,14 @@ advanced usages.
532532
The documentation for releases and `main` are available here:
533533

534534
* [`main`](https://pointfreeco.github.io/swift-composable-architecture/main/documentation/composablearchitecture/)
535-
* [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))
535+
* [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))
536536

537537
<details>
538538
<summary>
539539
Other versions
540540
</summary>
541541

542+
* [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))
542543
* [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))
543544
* [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))
544545
* [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))

Sources/ComposableArchitecture/Documentation.docc/Articles/MigrationGuides.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -14,6 +14,7 @@ APIs, and these guides contain tips to do so.
1414
1515
## Topics
1616

17+
- <doc:MigratingTo1.11>
1718
- <doc:MigratingTo1.10>
1819
- <doc:MigratingTo1.9>
1920
- <doc:MigratingTo1.8>

Sources/ComposableArchitecture/Documentation.docc/Articles/MigrationGuides/MigrationTo1.11.md renamed to Sources/ComposableArchitecture/Documentation.docc/Articles/MigrationGuides/MigratingTo1.11.md

File renamed without changes.

Sources/ComposableArchitecture/Documentation.docc/Extensions/AppStorageKey.md

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -28,3 +28,7 @@
2828

2929
- ``PersistenceReaderKey/appStorage(_:)-5jsie``
3030
- ``AppStorageKeyPathKey``
31+
32+
### Overriding app storage
33+
34+
- ``Dependencies/DependencyValues/defaultAppStorage``

Sources/ComposableArchitecture/Documentation.docc/Extensions/FileStorageKey.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -8,6 +8,7 @@
88

99
### Overriding storage
1010

11+
- ``Dependencies/DependencyValues/defaultFileStorage``
1112
- ``FileStorage``
1213

1314
### Deprecations

Sources/ComposableArchitecture/Documentation.docc/Extensions/InMemoryKey.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -8,4 +8,5 @@
88

99
### Overriding storage
1010

11+
- ``Dependencies/DependencyValues/defaultInMemoryStorage``
1112
- ``InMemoryStorage``

Sources/ComposableArchitecture/Documentation.docc/Extensions/Reducer.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -33,6 +33,7 @@
3333

3434
- ``EmptyReducer``
3535
- ``BindingReducer``
36+
- ``Swift/Optional``
3637

3738
### Reducer modifiers
3839

Sources/ComposableArchitecture/Documentation.docc/Extensions/Store.md

Lines changed: 1 addition & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -29,8 +29,7 @@
2929

3030
### Scoping store bindings
3131

32-
- ``SwiftUI/Binding/scope(state:action:fileID:line:)``
33-
- ``SwiftUI/Binding/scope(state:action:)-35r82``
32+
- ``SwiftUI/Binding``
3433

3534
### Combine integration
3635

Lines changed: 19 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,19 @@
1+
# ``SwiftUI/Binding``
2+
3+
Learn how SwiftUI's `Binding` type has been extended for the Composable Architecture
4+
5+
## Overview
6+
7+
A binding to a ``Store``is extended with several unique scoping operations that can be used to power
8+
controls and drive navigation.
9+
10+
## Topics
11+
12+
### Control bindings
13+
14+
- ``SwiftUI/Binding/subscript(dynamicMember:)``
15+
16+
### Navigation bindings
17+
18+
- ``SwiftUI/Binding/scope(state:action:fileID:line:)``
19+
- ``SwiftUI/Binding/scope(state:action:)-35r82``
Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,8 @@
1+
# ``SwiftUI/Binding/scope(state:action:)-35r82``
2+
3+
## Topics
4+
5+
### Bindable
6+
7+
- ``SwiftUI/Bindable/scope(state:action:)``
8+
- ``Perception/Bindable/scope(state:action:)``

0 commit comments

Comments
 (0)