Sort documentation into categories and write a few overviews

Author: stackotter

Sources/SwiftCrossUI/Backend/AppBackend.swift

@@ -1,6 +1,7 @@
 import Foundation
 
-/// A backend that can be used to run an app (e.g. Gtk or Qt).
+/// A backend that can be used to run an app. Usually built on top of an
+/// existing UI framework.
 ///
 /// Default placeholder implementations are available for all non-essential
 /// app lifecycle methods. These implementations will fatally crash when called

Sources/SwiftCrossUI/Backend/InheritedOrientation.swift

@@ -13,6 +13,7 @@ public macro HotReloadable() =
 public macro hotReloadable<T: View>(@ViewBuilder _ expr: () -> T) -> HotReloadableView =
     #externalMacro(module: "HotReloadingMacrosPlugin", type: "HotReloadableExprMacro")
 
+@_documentation(visibility: internal)
 public struct ExprLocation: Hashable {
     var line: Int
     var column: Int

Sources/SwiftCrossUI/HotReloadingMacros.swift

@@ -1,27 +1,27 @@
 extension Scene {
-    public func commands(@CommandsBuilder _ commands: () -> Commands) -> CommandsModifier<Self> {
+    public func commands(@CommandsBuilder _ commands: () -> Commands) -> some Scene {
         CommandsModifier(content: self, newCommands: commands())
     }
 }
 
-public struct CommandsModifier<Content: Scene>: Scene {
-    public typealias Node = CommandsModifierNode<Content>
+struct CommandsModifier<Content: Scene>: Scene {
+    typealias Node = CommandsModifierNode<Content>
 
-    public var content: Content
-    public var commands: Commands
+    var content: Content
+    var commands: Commands
 
-    public init(content: Content, newCommands: Commands) {
+    init(content: Content, newCommands: Commands) {
         self.content = content
         self.commands = content.commands.overlayed(with: newCommands)
     }
 }
 
-public final class CommandsModifierNode<Content: Scene>: SceneGraphNode {
-    public typealias NodeScene = CommandsModifier<Content>
+final class CommandsModifierNode<Content: Scene>: SceneGraphNode {
+    typealias NodeScene = CommandsModifier<Content>
 
     var contentNode: Content.Node
 
-    public init<Backend: AppBackend>(
+    init<Backend: AppBackend>(
         from scene: NodeScene,
         backend: Backend,
         environment: EnvironmentValues
@@ -33,7 +33,7 @@ public final class CommandsModifierNode<Content: Scene>: SceneGraphNode {
         )
     }
 
-    public func update<Backend: AppBackend>(
+    func update<Backend: AppBackend>(
         _ newScene: NodeScene?,
         backend: Backend,
         environment: EnvironmentValues

Sources/SwiftCrossUI/Scenes/Modifiers/CommandsModifier.swift

@@ -1,6 +1,6 @@
 # AppKitBackend
 
-SwiftCrossUI's native macOS backend built on AppKit.
+SwiftCrossUI's native macOS backend built on top of AppKit.
 
 ## Overview
 

Sources/SwiftCrossUI/SwiftCrossUI.docc/AppKitBackend.md

@@ -0,0 +1,16 @@
+# Built-in backends
+
+## Overview
+
+SwiftCrossUI has a variety of backends tailored to different operating systems.
+
+The beauty of SwiftCrossUI is that you can write your app once and have it look native everywhere. For this reason I recommend using `DefaultBackend` unless you've got particular constraints.
+
+## Topics
+
+- <doc:DefaultBackend>
+- <doc:AppKitBackend>
+- <doc:UIKitBackend>
+- <doc:WinUIBackend>
+- <doc:GtkBackend>
+- <doc:Gtk3Backend>

Sources/SwiftCrossUI/SwiftCrossUI.docc/Built-in backends.md

@@ -0,0 +1,23 @@
+# Controls
+
+## Overview
+
+Employ controls to receive user input.
+
+## Topics
+
+- ``Button``
+- ``TextField``
+- ``Slider``
+- ``Toggle``
+- ``Picker``
+- ``Menu``
+- ``List``
+
+### Related
+
+- ``DoubleConvertible``
+- ``MenuItem``
+- ``MenuItemsBuilder``
+- ``ToggleStyle``
+- ``TextContentType``

Sources/SwiftCrossUI/SwiftCrossUI.docc/Controls.md

@@ -0,0 +1,16 @@
+# Custom backends
+
+## Overview
+
+With being open and extensible as a core goal, SwiftCrossUI allows custom
+backends to be implemented in third-party packages.
+
+'Simply' implement the ``AppBackend`` protocol and you're good to go!
+
+## Topics
+
+- ``AppBackend``
+- ``CellPosition``
+- ``MenuImplementationStyle``
+- ``DialogResult``
+- ``ResolvedMenu``

Sources/SwiftCrossUI/SwiftCrossUI.docc/Custom backends.md

@@ -0,0 +1,7 @@
+# Deprecated
+
+## Topics
+
+- ``ViewContent``
+- ``Observable``
+- ``Observed``

Sources/SwiftCrossUI/SwiftCrossUI.docc/Deprecated.md

@@ -0,0 +1,41 @@
+# Environment
+
+## Topics
+
+- ``Environment``
+- ``EnvironmentValues``
+
+### Layout
+
+- ``EnvironmentValues/layoutOrientation``
+- ``Orientation``
+- ``EnvironmentValues/layoutAlignment``
+- ``StackAlignment``
+
+### Actions
+
+- ``EnvironmentValues/openURL``
+- ``OpenURLAction``
+
+- ``EnvironmentValues/revealFile``
+- ``RevealFileAction``
+
+- ``EnvironmentValues/chooseFileSaveDestination``
+- ``PresentFileSaveDialogAction``
+- ``SaveDialogOptions``
+- ``ContentType``
+
+- ``EnvironmentValues/chooseFile``
+- ``FileDialogOptions``
+- ``OpenDialogOptions``
+- ``PresentSingleFileOpenDialogAction``
+- ``FileChooserResult``
+
+- ``EnvironmentValues/presentAlert``
+- ``PresentAlertAction``
+- ``AlertAction``
+- ``AlertActionsBuilder``
+
+### Custom environment values
+
+- ``EnvironmentKey``