Skip to content

docs(icloud): define sync architecture - #16

Merged
serabi merged 2 commits into
mainfrom
codex/icloud-sync-design
Jul 14, 2026
Merged

serabi merged 2 commits into
mainfrom
codex/icloud-sync-design

Conversation

@serabi

@serabi serabi commented Jul 9, 2026 •

Copy link
Copy Markdown
Contributor

What changed

  • define private CloudKit and CKSyncEngine architecture for Piperly sync
  • specify the record schema, stable IDs, local queue, conflict rules, and deletion behavior
  • define EPUB and cover CKAsset lifecycle, privacy boundaries, test seams, and release checks
  • split implementation into five small follow-up PRs

Why

PR #15 establishes reader profiles and the product decision to use private iCloud sync. This ADR fixes the technical boundaries before implementation so the next PRs share one record model, offline behavior, and merge policy.

Impact

Documentation only. No runtime behavior changes.

Validation

  • reviewed against the current Piperly models and storage paths
  • checked against Apple's current CloudKit, CKSyncEngine, and CKAsset guidance
  • git diff --check

Stack

Base: #15

Next: profile-scoped reader preferences, then stable book identity, private sync engine, asset lifecycle, and parent controls/release readiness.


View with Codesmith Autofix with Codesmith
Need help on this PR? Tag /codesmith with what you need. Autofix is disabled.

@serabi
serabi changed the base branch from add-icloud-sync-adr to main July 10, 2026 23:59
@serabi
serabi marked this pull request as ready for review July 11, 2026 00:00
@serabi
serabi merged commit 88ab8d0 into main Jul 14, 2026
2 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant