Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

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

Merged
merged 2 commits into from
Jun 6, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
3 changes: 2 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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))
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -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>
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -28,3 +28,7 @@

- ``PersistenceReaderKey/appStorage(_:)-5jsie``
- ``AppStorageKeyPathKey``

### Overriding app storage

- ``Dependencies/DependencyValues/defaultAppStorage``
Original file line number Diff line number Diff line change
Expand Up @@ -8,6 +8,7 @@

### Overriding storage

- ``Dependencies/DependencyValues/defaultFileStorage``
- ``FileStorage``

### Deprecations
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -8,4 +8,5 @@

### Overriding storage

- ``Dependencies/DependencyValues/defaultInMemoryStorage``
- ``InMemoryStorage``
Original file line number Diff line number Diff line change
Expand Up @@ -33,6 +33,7 @@

- ``EmptyReducer``
- ``BindingReducer``
- ``Swift/Optional``

### Reducer modifiers

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -29,8 +29,7 @@

### Scoping store bindings

- ``SwiftUI/Binding/scope(state:action:fileID:line:)``
- ``SwiftUI/Binding/scope(state:action:)-35r82``
- ``SwiftUI/Binding``

### Combine integration

Expand Down
Original file line number Diff line number Diff line change
@@ -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``
Original file line number Diff line number Diff line change
@@ -0,0 +1,8 @@
# ``SwiftUI/Binding/scope(state:action:)-35r82``

## Topics

### Bindable

- ``SwiftUI/Bindable/scope(state:action:)``
- ``Perception/Bindable/scope(state:action:)``
Original file line number Diff line number Diff line change
@@ -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:)``
Original file line number Diff line number Diff line change
@@ -0,0 +1,8 @@
# ``SwiftUI/Binding/subscript(dynamicMember:)``

## Topics

### Bindable

- ``SwiftUI/Bindable/subscript(dynamicMember:)``
- ``Perception/Bindable/subscript(dynamicMember:)``
Loading