diff --git a/Documentation/build-docc.sh b/Documentation/build-docc.sh new file mode 100644 index 0000000..def6a16 --- /dev/null +++ b/Documentation/build-docc.sh @@ -0,0 +1,11 @@ +#!/usr/bin/env bash +set -euo pipefail + +ROOT_DIR="$(cd "$(dirname "${BASH_SOURCE[0]}")/.." && pwd)" + +cd "$ROOT_DIR" + +xcodebuild docbuild \ + -workspace .swiftpm/xcode/package.xcworkspace \ + -scheme LocalData \ + -destination 'generic/platform=iOS' diff --git a/README.md b/README.md index 3de2b13..ff1a250 100644 --- a/README.md +++ b/README.md @@ -460,6 +460,20 @@ For end-to-end iOS + watchOS setup (including a launch-order-safe handshake), se ## Testing - Unit tests use Swift Testing (`Testing` package) +## DocC Documentation + +DocC uses the SwiftPM-generated workspace under `.swiftpm/xcode/`. + +Build the documentation archive from the package root: + +```bash +./Documentation/build-docc.sh +``` + +Docs live in two places: +- `Sources/LocalData/Documentation.docc` (DocC guides and Home page) +- `Documentation/` (additional reference docs) + ## Storage Audit LocalData can generate a catalog of all configured storage keys, even if no data has been written yet. This is useful for security reviews and compliance.