rename Docs directory, add Security page

Author: ktoso

InternalPlugins/FishyDocs/Plugins/FishyDocsPlugin/plugin.swift

@@ -4,7 +4,7 @@ import PackagePlugin
 @main struct FishyDocsBuildPlugin: BuildToolPlugin {
     func createBuildCommands(context: PluginContext, target: Target) async throws -> [Command] {
         let genSourcesDir = context.pluginWorkDirectory
-        let doccBasePath = "\(context.package.directory)/Sources/DistributedActors/DistributedActors.docc"
+        let doccBasePath = "\(context.package.directory)/Sources/DistributedActors/Docs.docc"
 
         let mdFiles = try FileManager.default
             .contentsOfDirectory(atPath: doccBasePath)

Sources/DistributedActors/ClusterSystem.swift

@@ -460,7 +460,7 @@ public class ClusterSystem: DistributedActorSystem, @unchecked Sendable {
         }
     }
 
-    /// Suspends until the ``ClusterSystem`` is terminated by a call to ``shutdown(queue:)``.
+    /// Suspends until the ``ClusterSystem`` is terminated by a call to ``shutdown()``.
     public var terminated: Void {
         get async throws {
             try await Shutdown(receptacle: self.shutdownReceptacle).wait()

Sources/DistributedActors/ClusterSystemSettings.swift

@@ -175,9 +175,17 @@ public struct ClusterSystemSettings {
     // ==== ------------------------------------------------------------------------------------------------------------
     // MARK: TLS & Security settings
 
-    /// If set, all communication with other nodes will be secured using TLS
+    /// If set, all communication with other nodes will be secured using TLS.
+    ///
+    /// The configuration is a `NIOSSL.TLSConfiguration`, so please refer to
+    /// [swift-nio-ssl](https://github.com/apple/swift-nio-ssl) documentation for more details about it.
+    ///
+    /// - SeeAlso: `NIOSSL.NIOSSLContext`
     public var tls: TLSConfiguration?
 
+    /// Callback invoked when a passphrase is required for TLS.
+    ///
+    /// - SeeAlso: `NIOSSL.NIOSSLContext`
     public var tlsPassphraseCallback: NIOSSLPassphraseCallback<[UInt8]>?
 
     // ==== ------------------------------------------------------------------------------------------------------------

…stributedActors.docc/ClusterSingleton.md …utedActors/Docs.docc/ClusterSingleton.mdSources/DistributedActors/DistributedActors.docc/ClusterSingleton.md renamed to Sources/DistributedActors/Docs.docc/ClusterSingleton.md Sources/DistributedActors/DistributedActors.docc/ClusterSingleton.md renamed to Sources/DistributedActors/Docs.docc/ClusterSingleton.md

@@ -193,7 +193,7 @@ design your distributed actors with idempotency (the resilience of a method bein
 
 By default, to avoid "hanging" a remote caller forever on a suspended remote call as the recipient node fails to reply to it,
 for example because it (or the network itself), is currently unresponsive, remote calls have a default timeout configured.
-If no reply is received within this duration, the call will fail with a ``RemoteCallError/timedOut(_:_:)``.
+If no reply is received within this duration, the call will fail with a ``RemoteCallError``.
 
 You can configure the default timeout used by the cluster system during its initialization:
 

…ors/DistributedActors.docc/Clustering.md …istributedActors/Docs.docc/Clustering.mdSources/DistributedActors/DistributedActors.docc/Clustering.md renamed to Sources/DistributedActors/Docs.docc/Clustering.md Sources/DistributedActors/DistributedActors.docc/Clustering.md renamed to Sources/DistributedActors/Docs.docc/Clustering.md

@@ -101,8 +101,3 @@ distributed actor Boss: LifecycleWatch {
 }
 ```
 
-## Topics
-
-### <!--@START_MENU_TOKEN@-->Group<!--@END_MENU_TOKEN@-->
-
-- <!--@START_MENU_TOKEN@-->``Symbol``<!--@END_MENU_TOKEN@-->