Skip to main content

max / synckit

Correct the synckit-client doc paths and the store module list integration_patterns.md pointed the four SDK rows at a tree-absolute path. Make them crate-relative and note the convention, since the consuming-repo rows cannot be. README.md: the store/ row omitted the deferred module.
Co-Authored-By
Claude Opus 5 (1M context) <noreply@anthropic.com>
Author: Max Johnson <me@maxj.phd> · 2026-07-30 23:49 UTC
Signed with PGP, not checked
Commit: ab3881358d126d065c33a432e13229732b0f0692
Parent: 731fb67
2 files changed, +8 insertions, -5 deletions
@@ -59,7 +59,7 @@
59 59 |------|------|
60 60 | `lib.rs` | Crate root, re-exports, doc example |
61 61 | `client/` | `SyncKitClient`: HTTP transport and the high-level API, with transparent end-to-end encryption. Split across `auth`, `blob`, `encryption`, `groups`, `helpers`, `ota`, `rotation`, `subscribe`, `subscription`, `sync` |
62 - | `store/` | `SyncStore`, the syncable-store engine: `apply`, `blob`, `config`, `db`, `facade`, `hlc`, `migrate`, `scheduler`, `schema`, `sync` |
62 + | `store/` | `SyncStore`, the syncable-store engine: `apply`, `blob`, `config`, `db`, `deferred`, `facade`, `hlc`, `migrate`, `scheduler`, `schema`, `sync` |
63 63 | `crypto.rs` | Key derivation (Argon2id), key wrapping, per-entry and per-blob encrypt/decrypt |
64 64 | `identity.rs` | Group identity keys and Group Content Key grants, the crate's one asymmetric layer |
65 65 | `conflict.rs` | Client-side conflict detection and resolution |
@@ -294,12 +294,15 @@
294 294
295 295 ## Key Files
296 296
297 + SDK paths are relative to this crate root. The rest are relative to the code tree the
298 + consuming repos are checked out into.
299 +
297 300 | What | Where |
298 301 |------|-------|
299 - | SDK source | `synckit/synckit-client/src/` |
300 - | SDK auth | `synckit/synckit-client/src/client/auth.rs` |
301 - | SDK push/pull | `synckit/synckit-client/src/client/sync.rs` |
302 - | SDK encryption | `synckit/synckit-client/src/crypto.rs` |
302 + | SDK source | `src/` |
303 + | SDK auth | `src/client/auth.rs` |
304 + | SDK push/pull | `src/client/sync.rs` |
305 + | SDK encryption | `src/crypto.rs` |
303 306 | GO sync | `Apps/goingson/src-tauri/src/syncstore/` |
304 307 | BB sync service | `Apps/balanced_breakfast/src-tauri/src/sync_service/` |
305 308 | AF sync service | `Apps/audiofiles/crates/audiofiles-sync/src/service/` |