Reorganize Documentation

vsanthanam · Jun 13, 2022 · 25f7a0a · 25f7a0a
1 parent 1bec4fc
commit 25f7a0a
Show file tree

Hide file tree

Showing 4 changed files with 4 additions and 14 deletions.
diff --git a/Sources/NetworkReachability/API/NetworkMonitor/NetworkMonitor.swift b/Sources/NetworkReachability/API/NetworkMonitor/NetworkMonitor.swift
@@ -39,8 +39,6 @@ import Network
 /// - Using a provided closure via the ``updateHandler-swift.property`` property.
 /// - Using notification observers on [`NotificationCenter.default`](https://developer.apple.com/documentation/foundation/notificationcenter).
 ///
-/// See the <doc:NetworkMonitorGuide> for more information.
-///
 /// ## Topics
 ///
 /// ### Initializers

diff --git a/Sources/NetworkReachability/API/ReachabilityMonitor/ReachabilityMonitor.swift b/Sources/NetworkReachability/API/ReachabilityMonitor/ReachabilityMonitor.swift
@@ -38,8 +38,6 @@ import SystemConfiguration
 /// - Using a provided closure via the ``updateHandler-swift.property`` property.
 /// - Using notification observers on [`NotificationCenter.default`](https://developer.apple.com/documentation/foundation/notificationcenter).
 ///
-/// See the <doc:ReachabilityMonitorGuide> for more information.
-///
 /// ## Topics
 ///
 /// ### Initializers

diff --git a/Sources/NetworkReachability/NetworkReachability.docc/NetworkReachability.md b/Sources/NetworkReachability/NetworkReachability.docc/NetworkReachability.md
@@ -4,25 +4,19 @@ A Swift replacement for `SCNetworkReachability` & `NWPathMonitor` with support f
 
 NetworkReachability is a replacement for Apple's [SystemConfiguration](https://developer.apple.com/documentation/systemconfiguration) [Network Reachability APIs](https://developer.apple.com/documentation/systemconfiguration/scnetworkreachability?language=swift). Because these APIs were originally written in C, they are old and cumbersome to use from Swift. In 2018, Apple added the [Network](https://developer.apple.com/documentation/network) framework which introduced the [`NWPathMonitor`](https://developer.apple.com/documentation/network/nwpathmonitor) class. This API addressed some of the problems with [`SCNetworkReachability`](https://developer.apple.com/documentation/systemconfiguration/scnetworkreachability?language=swift), but was still cumbersome to integrate into many commonly used app patterns. NetworkReachability wraps both these APIs in an easy to use Swift wrapper with similar interfaces and features sthat will be familiar to most iOS developers.
 
-## Usage
-
-To determine the current reachability status. Initialize an instance of ``ReachabilityMonitor`` or ``NetworkMonitor`` and retain it in memory. Both classes support a number of observability mechanisms and should be easy to integrate into your data pipelines.
-
-## Essentials
-
-- <doc:GettingStarted>
-- <doc:NetworkMonitorGuide>
-- <doc:ReachabilityMonitorGuide>
+Take a look at our <doc:GettingStarted> guide for more information.
 
 ## Topics
 
 ### Network Monitor
 
+- <doc:NetworkMonitorGuide>
 - ``NetworkMonitor``
 - ``NetworkMonitorDelegate``
 
 ### Reachability Monitor
 
+- <doc:ReachabilityMonitorGuide>
 - ``ReachabilityMonitor``
 - ``ReachabilityMonitorDelegate``
 - ``Reachability``
diff --git a/Sources/NetworkReachability/NetworkReachability.docc/ReachabilityMonitorGuide.md b/Sources/NetworkReachability/NetworkReachability.docc/ReachabilityMonitorGuide.md
@@ -19,7 +19,7 @@ do {
 
 Unlike ``NetworkMonitor``, ``ReachabilityMonitor``'s synchronous API is gauranteed to provide up-date-values. 
 
-### Observing reachability updates.
+### Observing reachability updates
 
 If you need to observe all reachability changes, ``ReachabilityMonitor`` provides several asynchronous APIs that will allow you to integrate reachability data into any existing pipeline.