From f085dc9f65e005286879f2019831c667f423219d Mon Sep 17 00:00:00 2001 From: Matt Bruce Date: Sat, 17 Jan 2026 11:22:03 -0600 Subject: [PATCH] Update Documentation.docc and docs Summary: - Sources: update Documentation.docc - Docs: update docs for build-docc Stats: - 4 files changed, 19 insertions(+), 8 deletions(-) --- Documentation/build-docc.sh | 7 +++++++ .../Documentation.docc/GettingStarted.md | 2 +- .../KeyAndCatalogDiscipline.md | 2 +- .../LocalData/Documentation.docc/LocalData.md | 16 ++++++++++------ 4 files changed, 19 insertions(+), 8 deletions(-) diff --git a/Documentation/build-docc.sh b/Documentation/build-docc.sh index def6a16..fbf6e27 100644 --- a/Documentation/build-docc.sh +++ b/Documentation/build-docc.sh @@ -9,3 +9,10 @@ xcodebuild docbuild \ -workspace .swiftpm/xcode/package.xcworkspace \ -scheme LocalData \ -destination 'generic/platform=iOS' + +ARCHIVE_PATH="$(find "${HOME}/Library/Developer/Xcode/DerivedData" -type d -name 'LocalData.doccarchive' 2>/dev/null | sort | tail -n 1)" +if [[ -n "${ARCHIVE_PATH}" ]]; then + echo "DocC archive: ${ARCHIVE_PATH}" +else + echo "DocC archive not found in DerivedData." +fi diff --git a/Sources/LocalData/Documentation.docc/GettingStarted.md b/Sources/LocalData/Documentation.docc/GettingStarted.md index e5541ee..58e668c 100644 --- a/Sources/LocalData/Documentation.docc/GettingStarted.md +++ b/Sources/LocalData/Documentation.docc/GettingStarted.md @@ -35,7 +35,7 @@ await StorageRouter.shared.updateStorageConfiguration(storageConfig) Catalogs are mandatory if you want auditing and duplicate detection. -> [!IMPORTANT] +> Important: > Once any catalog is registered, *all* storage operations require the key to be present in a registered catalog. > Unregistered keys will throw `StorageError.unregisteredKey`. diff --git a/Sources/LocalData/Documentation.docc/KeyAndCatalogDiscipline.md b/Sources/LocalData/Documentation.docc/KeyAndCatalogDiscipline.md index f473910..734ca1d 100644 --- a/Sources/LocalData/Documentation.docc/KeyAndCatalogDiscipline.md +++ b/Sources/LocalData/Documentation.docc/KeyAndCatalogDiscipline.md @@ -18,7 +18,7 @@ Catalog registration enforces correctness: - Duplicate key names across catalogs are rejected. - Unregistered keys throw ``StorageError/unregisteredKey(_:)`` at runtime. -> [!IMPORTANT] +> Important: > Once any catalog is registered, *all* storage operations require keys to be registered. > If you add a new module or feature, you must register its catalog before using its keys. diff --git a/Sources/LocalData/Documentation.docc/LocalData.md b/Sources/LocalData/Documentation.docc/LocalData.md index 9fca678..0c91371 100644 --- a/Sources/LocalData/Documentation.docc/LocalData.md +++ b/Sources/LocalData/Documentation.docc/LocalData.md @@ -1,4 +1,8 @@ -# LocalData +# ``LocalData`` + +@Metadata { + @TechnologyRoot +} LocalData is a typed, auditable storage layer that unifies UserDefaults, Keychain, and file storage under a single API. It favors static, discoverable keys and explicit catalogs so teams can reason about what is stored, where it lives, and how it is secured. @@ -12,24 +16,24 @@ LocalData revolves around three concepts: ## Topics -### Getting Started +### Start Here - - -### Migrations +### Migration Guides - -### Sync +### Sync Guides - -### Security +### Security Guides - -### Testing +### Testing Guides -