Skip to content

Commit adaf61d

Browse files
leogdionclaude
andcommitted
docs(docc): remove MainActor references and transport selection details
- Remove @mainactor mentions from SundialKitCombine descriptions - Remove "all updates happen on main thread" explanations - Remove automatic transport selection details from connectivity docs - Preserve actor-based descriptions for SundialKitStream - Simplify plugin comparison focusing on observation patterns 🤖 Generated with [Claude Code](https://claude.com/claude-code) Co-Authored-By: Claude <noreply@anthropic.com>
1 parent 6fa0a83 commit adaf61d

4 files changed

Lines changed: 8 additions & 10 deletions

File tree

Packages/SundialKitCombine/Sources/SundialKitCombine/SundialKitCombine.docc/Documentation.md

Lines changed: 2 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,14 +1,13 @@
11
# ``SundialKitCombine``
22

3-
Combine-based observation plugin for SundialKit with @MainActor isolation and @Published properties.
3+
Combine-based observation plugin for SundialKit with @Published properties.
44

55
## Overview
66

7-
SundialKitCombine provides @MainActor-isolated observers that deliver state updates via @Published properties and Combine publishers. This plugin is designed for SwiftUI projects and apps requiring backward compatibility with iOS 13+.
7+
SundialKitCombine provides observers that deliver state updates via @Published properties and Combine publishers. This plugin is designed for SwiftUI projects and apps requiring backward compatibility with iOS 13+.
88

99
### Key Features
1010

11-
- **@MainActor Isolation**: All state updates occur on the main thread
1211
- **@Published Properties**: Direct binding to SwiftUI views
1312
- **Combine Publishers**: Full reactive programming support
1413
- **Swift 6.1 Strict Concurrency**: Zero `@unchecked Sendable` conformances

Sources/SundialKit/SundialKit.docc/Documentation.md

Lines changed: 1 addition & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -304,9 +304,8 @@ print("Sent via: \(result.context)")
304304
- Actor-based observers with natural thread safety
305305
- Ideal for new projects using async/await
306306

307-
**<doc:SundialKitCombine>** (@MainActor + Combine):
307+
**<doc:SundialKitCombine>** (Combine Publishers):
308308
- @Published properties and Combine publishers
309-
- @MainActor isolation for UI safety
310309
- Compatible with iOS 13+ and SwiftUI projects
311310

312311
Both plugins work with the same core <doc:SundialKitNetwork> and <doc:SundialKitConnectivity> packages - just choose the observation style that fits your project.

Sources/SundialKitConnectivity/SundialKitConnectivity.docc/Documentation.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -25,7 +25,7 @@ SundialKitConnectivity provides a modern, type-safe wrapper around Apple's [Watc
2525

2626
SundialKitConnectivity provides the foundational WatchConnectivity protocols and messaging types. To use these in your application, you'll need to choose an observation plugin that matches your preferred concurrency model:
2727

28-
- **SundialKitCombine** - For SwiftUI apps using `@MainActor` and Combine publishers
28+
- **SundialKitCombine** - For SwiftUI apps using Combine publishers
2929
- **SundialKitStream** - For modern Swift apps using actors and AsyncStreams
3030

3131
Both plugins provide `ConnectivityObserver` classes that handle session management and message routing automatically. The examples below demonstrate how to define and send type-safe messages using each approach.
@@ -130,11 +130,11 @@ With binary serialization, you can transfer complex data structures efficiently.
130130

131131
### Session Management
132132

133-
Once you've defined your message types, you'll use a `ConnectivityObserver` to manage the WatchConnectivity session and send/receive messages. The observer handles session activation, monitors reachability, and automatically chooses the best transport method based on whether the counterpart device is currently available.
133+
Once you've defined your message types, you'll use a `ConnectivityObserver` to manage the WatchConnectivity session and send/receive messages. The observer handles session activation and monitors reachability.
134134

135135
#### Using with SundialKitCombine
136136

137-
The Combine-based observer is perfect for SwiftUI applications. It provides `@Published` properties for session state and Combine publishers for incoming messages, making it easy to update your UI reactively. All updates happen on the main thread.
137+
The Combine-based observer is perfect for SwiftUI applications. It provides `@Published` properties for session state and Combine publishers for incoming messages, making it easy to update your UI reactively.
138138

139139
```swift
140140
import SundialKitCombine

Sources/SundialKitNetwork/SundialKitNetwork.docc/Documentation.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -23,7 +23,7 @@ SundialKitNetwork provides protocol-based abstractions over Apple's [Network fra
2323

2424
SundialKitNetwork provides the foundational network monitoring protocols and types. To use these in your application, you'll need to choose an observation plugin that matches your preferred concurrency model:
2525

26-
- **SundialKitCombine** - For SwiftUI apps using `@MainActor` and Combine publishers
26+
- **SundialKitCombine** - For SwiftUI apps using Combine publishers
2727
- **SundialKitStream** - For modern Swift apps using actors and AsyncStreams
2828

2929
Both plugins provide `NetworkObserver` classes that wrap SundialKitNetwork's protocols with reactive APIs. The examples below show how to use each approach.
@@ -32,7 +32,7 @@ Both plugins provide `NetworkObserver` classes that wrap SundialKitNetwork's pro
3232

3333
#### Using with SundialKitCombine
3434

35-
The Combine-based observer is ideal for SwiftUI applications where you want to bind network state directly to your UI. All updates happen on the main thread, making it safe to update views directly from the observers.
35+
The Combine-based observer is ideal for SwiftUI applications where you want to bind network state directly to your UI.
3636

3737
```swift
3838
import SundialKitCombine

0 commit comments

Comments
 (0)