Docs build-docc, README
Summary: - Docs: build-docc, README Stats: - 2 files changed, 25 insertions(+)
This commit is contained in:
parent
6fc5ef8d08
commit
982a12099e
11
Documentation/build-docc.sh
Normal file
11
Documentation/build-docc.sh
Normal file
@ -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'
|
||||||
14
README.md
14
README.md
@ -460,6 +460,20 @@ For end-to-end iOS + watchOS setup (including a launch-order-safe handshake), se
|
|||||||
## Testing
|
## Testing
|
||||||
- Unit tests use Swift Testing (`Testing` package)
|
- 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
|
## 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.
|
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.
|
||||||
|
|||||||
Loading…
Reference in New Issue
Block a user