Signed-off-by: Matt Bruce <mbrucedogs@gmail.com>

This commit is contained in:
Matt Bruce 2026-01-17 11:22:03 -06:00
parent 9a6b91b75b
commit cb188829f6
4 changed files with 19 additions and 8 deletions

View File

@ -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

View File

@ -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`.

View File

@ -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.

View File

@ -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
- <doc:GettingStarted>
- <doc:KeyAndCatalogDiscipline>
### Migrations
### Migration Guides
- <doc:Migrations>
### Sync
### Sync Guides
- <doc:WatchSync>
### Security
### Security Guides
- <doc:Security>
### Testing
### Testing Guides
- <doc:Testing>