Documentation & Comments

Summary

Top-level README.md exists; per-package READMEs in Costco-Digital/ are absent. DocC not adopted. No ADRs.

Documentation surface vs target

DocC quick-start

# Add a documentation catalog to a package:
# Costco-Digital/Core/Sources/Core/Core.docc/Core.md

# Document a public type:
/// A high-level description.
///
/// Detailed description with examples.
///
/// - Important: Anything thread-safety or lifecycle related.
public protocol NetworkClient {
    /// Sends a request and returns a typed response.
    func send<T: Decodable>(_ request: APIRequest<T>) async throws -> T
}

# Build & preview:
swift package generate-documentation --target Core
swift package --disable-sandbox preview-documentation --target Core

Suggested ADR backlog

1. Why CocoaPods + SPM hybrid (and the migration plan).
2. MVVM as default architecture — when to use Coordinators / TCA.
3. RZVinyl retirement strategy and replacement (CostcoNetworkClient + Codable).
4. SwiftUI vs UIKit for new screens (decision tree).
5. Snapshot testing baseline (per-locale plans, when to update reference images).
6. Privacy Manifest workflow (who owns updates).

Findings