Re-org, document

Author: thecoolwinter

…s/LSP/Registry/PackageManagerError.swift …egistry/Errors/PackageManagerError.swiftCodeEdit/Features/LSP/Registry/PackageManagerError.swift renamed to CodeEdit/Features/LSP/Registry/Errors/PackageManagerError.swift CodeEdit/Features/LSP/Registry/PackageManagerError.swift renamed to CodeEdit/Features/LSP/Registry/Errors/PackageManagerError.swift

@@ -0,0 +1,52 @@
+//
+//  PackageSource.swift
+//  CodeEdit
+//
+//  Created by Khan Winter on 8/18/25.
+//
+
+/// Generic package source information that applies to all installation methods.
+/// Takes all the necessary information from `RegistryItem`.
+struct PackageSource: Equatable, Codable {
+    /// The raw source ID string from the registry
+    let sourceId: String
+    /// The type of the package manager
+    let type: PackageManagerType
+    /// Package name
+    let pkgName: String
+    /// The name in the registry.json file. Used for the folder name when saved.
+    let entryName: String
+    /// Package version
+    let version: String
+    /// URL for repository or download link
+    let repositoryUrl: String?
+    /// Git reference type if this is a git based package
+    let gitReference: GitReference?
+    /// Additional possible options
+    var options: [String: String]
+
+    init(
+        sourceId: String,
+        type: PackageManagerType,
+        pkgName: String,
+        entryName: String,
+        version: String,
+        repositoryUrl: String? = nil,
+        gitReference: GitReference? = nil,
+        options: [String: String] = [:]
+    ) {
+        self.sourceId = sourceId
+        self.type = type
+        self.pkgName = pkgName
+        self.entryName = entryName
+        self.version = version
+        self.repositoryUrl = repositoryUrl
+        self.gitReference = gitReference
+        self.options = options
+    }
+
+    enum GitReference: Equatable, Codable {
+        case tag(String)
+        case revision(String)
+    }
+}

…/LSP/Registry/RegistryManagerError.swift …gistry/Errors/RegistryManagerError.swiftCodeEdit/Features/LSP/Registry/RegistryManagerError.swift renamed to CodeEdit/Features/LSP/Registry/Errors/RegistryManagerError.swift CodeEdit/Features/LSP/Registry/RegistryManagerError.swift renamed to CodeEdit/Features/LSP/Registry/Errors/RegistryManagerError.swift

@@ -7,6 +7,7 @@
 
 import Foundation
 
+/// The protocol each package manager conforms to for creating ``PackageManagerInstallOperation``s.
 protocol PackageManagerProtocol {
     var shellClient: ShellClient { get }
 
@@ -17,49 +18,3 @@ protocol PackageManagerProtocol {
     /// Checks if the shell commands for the package manager are available or not
     func isInstalled(method installationMethod: InstallationMethod) -> PackageManagerInstallStep
 }
-
-/// Generic package source information that applies to all installation methods.
-/// Takes all the necessary information from `RegistryItem`.
-struct PackageSource: Equatable, Codable {
-    /// The raw source ID string from the registry
-    let sourceId: String
-    /// The type of the package manager
-    let type: PackageManagerType
-    /// Package name
-    let pkgName: String
-    /// The name in the registry.json file. Used for the folder name when saved.
-    let entryName: String
-    /// Package version
-    let version: String
-    /// URL for repository or download link
-    let repositoryUrl: String?
-    /// Git reference type if this is a git based package
-    let gitReference: GitReference?
-    /// Additional possible options
-    var options: [String: String]
-
-    init(
-        sourceId: String,
-        type: PackageManagerType,
-        pkgName: String,
-        entryName: String,
-        version: String,
-        repositoryUrl: String? = nil,
-        gitReference: GitReference? = nil,
-        options: [String: String] = [:]
-    ) {
-        self.sourceId = sourceId
-        self.type = type
-        self.pkgName = pkgName
-        self.entryName = entryName
-        self.version = version
-        self.repositoryUrl = repositoryUrl
-        self.gitReference = gitReference
-        self.options = options
-    }
-
-    enum GitReference: Equatable, Codable {
-        case tag(String)
-        case revision(String)
-    }
-}

…es/LSP/Registry/InstallationMethod.swift …/Registry/Model/InstallationMethod.swiftCodeEdit/Features/LSP/Registry/InstallationMethod.swift renamed to CodeEdit/Features/LSP/Registry/Model/InstallationMethod.swift CodeEdit/Features/LSP/Registry/InstallationMethod.swift renamed to CodeEdit/Features/LSP/Registry/Model/InstallationMethod.swift

@@ -9,10 +9,3 @@ enum InstallStepConfirmation {
     case none
     case required(message: String)
 }
-
-struct PackageManagerInstallStep: Identifiable {
-    var id: String { name }
-    let name: String
-    let confirmation: InstallStepConfirmation
-    let handler: (_ model: PackageManagerProgressModel) async throws -> Void
-}

…es/LSP/Registry/PackageManagerType.swift …/Registry/Model/PackageManagerType.swiftCodeEdit/Features/LSP/Registry/PackageManagerType.swift renamed to CodeEdit/Features/LSP/Registry/Model/PackageManagerType.swift CodeEdit/Features/LSP/Registry/PackageManagerType.swift renamed to CodeEdit/Features/LSP/Registry/Model/PackageManagerType.swift

@@ -8,6 +8,12 @@
 import Foundation
 import Combine
 
+/// An executable install operation for installing a ``RegistryItem``.
+///
+/// Has a single entry point, ``run()``, which kicks off the operation. UI can observe properties like the ``error``,
+/// ``runningState-swift.property``, or ``currentStep`` to monitor progress.
+///
+/// If a step requires confirmation, the ``waitingForConfirmation`` value will be filled.
 @MainActor
 final class PackageManagerInstallOperation: ObservableObject, Identifiable {
     enum RunningState {
@@ -34,10 +40,12 @@ final class PackageManagerInstallOperation: ObservableObject, Identifiable {
     let package: RegistryItem
     let steps: [PackageManagerInstallStep]
 
+    /// The step the operation is currently executing or stopped at.
     var currentStep: PackageManagerInstallStep? {
         steps[safe: currentStepIdx]
     }
 
+    /// The current state of the operation.
     var runningState: RunningState {
         if operationTask != nil {
             return .running
@@ -60,7 +68,12 @@ final class PackageManagerInstallOperation: ObservableObject, Identifiable {
     private var operationTask: Task<Void, Error>?
     private var confirmationContinuation: CheckedContinuation<Void, Never>?
     private var outputIdx = 0
-
+    
+    /// Create a new operation using a list of steps and a package description.
+    /// See ``PackageManagerProtocol`` for 
+    /// - Parameters:
+    ///   - package: The package to install.
+    ///   - steps: The steps that make up the operation.
     init(package: RegistryItem, steps: [PackageManagerInstallStep]) {
         self.package = package
         self.steps = steps