Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 3 additions & 3 deletions .claude/CLAUDE.md
Original file line number Diff line number Diff line change
Expand Up @@ -118,7 +118,7 @@ Use the Mintlify skill for syntax. These project conventions take precedence ove
| `<Info>` | Neutral background context |
| `<Check>` | Success confirmations |

In platform lists, tabs, code groups, accordions, and cards, order SDKs as follows: JavaScript variants (React Native, Web, Node.js), Dart, Kotlin, Swift, .NET, Rust. Put platform-specific extras such as Capacitor and Tauri after the JavaScript variants they belong to.
In platform lists, tabs, code groups, accordions, and cards, order SDKs as follows: JavaScript variants (Web, React Native, Node.js), Dart, Kotlin, Swift, .NET, Rust. Put platform-specific extras such as Capacitor and Tauri after the JavaScript variants they belong to.

Wrap images in a `Frame` with a caption and descriptive alt text:

Expand All @@ -130,7 +130,7 @@ Wrap images in a `Frame` with a caption and descriptive alt text:

### Code Examples

- Provide complete, runnable, tested examples with realistic data and expected output where useful. Never include real credentials or secrets.
- Make examples complete and runnable where possible. If an example needs a lot of boilerplate just to run, such as app setup or connector wiring, you may leave that out. Make the omission clear with a comment or a sentence before the code block, such as `// Inside your backend connector`. The code you show must still be correct. Use realistic data and expected output where useful. Never include real credentials or secrets.
- Give fenced code blocks a language tag. Use filenames only for self-hosted examples.
- Do not use placeholder names such as `foo`, `bar`, or `example.com` in runnable examples.
- In SQL, use table names directly unless an alias is necessary for a self-join or ambiguous column. Prefer `SELECT tasks.* FROM tasks JOIN projects ON ...` to aliases such as `t`.
Expand All @@ -152,7 +152,7 @@ Sync Rules are deprecated, but many customers still run them. New documentation

## Verification

- Verify technical claims and run code examples before publication. Select other checks appropriate to the change.
- Verify technical claims and run code examples before publication. Run an example that leaves out boilerplate with the boilerplate added. If that is not practical, check every API and behavior it shows against the SDK source. Select other checks appropriate to the change.
- Run `vale <file>` for changed MDX pages. Add new technical terms to `.github/vale/config/vocabularies/PowerSync/accept.txt`; do not add ordinary misspellings.
- After link or navigation changes, run `pnpm check:links`. It runs the Mintlify path, anchor, and snippet checks through `scripts/check-links.mjs`, resolves anchors defined in imported snippets, and is the same check CI runs. It tells you if your Node version is unsupported. Validate repository instruction links as file paths, since the site checker does not cover them.
- Use [the lint command](commands/lint-docs.md) for the check workflow and [the reviewer](agents/document-reviewer.md) for editorial review. Passing linters does not establish technical accuracy or style compliance.
Expand Down
2 changes: 2 additions & 0 deletions .github/vale/config/vocabularies/PowerSync/accept.txt
Original file line number Diff line number Diff line change
Expand Up @@ -23,6 +23,8 @@ composables
config
configs
cooldown
coroutine
coroutines
cybersecurity
dealbreaker
deduplicate
Expand Down
2 changes: 1 addition & 1 deletion client-sdks/checkpoint-requests.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -192,7 +192,7 @@ Creating the request has no timeout of its own, so it can stay suspended while t

Aborting a `waitForSync` call or configuring a timeout does not remove the checkpoint. It only limits how long you wait for the checkpoint to sync and apply locally.

The [React Native](https://github.com/powersync-ja/powersync-js/blob/main/demos/react-native-supabase-todolist/app/views/todos/lists.tsx), [React](https://github.com/powersync-ja/powersync-js/blob/main/demos/react-supabase-todolist/src/app/views/layout.tsx), [Flutter](https://github.com/powersync-ja/powersync.dart/blob/main/demos/supabase-todolist-drift/lib/stores/refresh.dart), [Kotlin](https://github.com/powersync-ja/powersync-kotlin/blob/main/demos/supabase-todolist/shared/src/commonMain/kotlin/com/powersync/demos/components/RefreshIcon.kt), and [Swift](https://github.com/powersync-ja/powersync-swift/blob/main/Demos/PowerSyncExample/PowerSyncExample/PowerSync/SystemManager.swift) demo apps use this pattern for a refresh action.
The [React Native](https://github.com/powersync-ja/powersync-js/blob/main/demos/react-native-supabase-todolist/app/views/todos/lists.tsx), [React](https://github.com/powersync-ja/powersync-js/blob/main/demos/react-supabase-todolist/src/app/views/layout.tsx), [Flutter](https://github.com/powersync-ja/powersync.dart/blob/main/demos/supabase-todolist-drift/lib/stores/refresh.dart), [Kotlin](https://github.com/powersync-ja/powersync-kotlin/blob/main/demos/supabase-todolist/shared/src/commonMain/kotlin/com/powersync/demos/components/RefreshIcon.kt), [Swift](https://github.com/powersync-ja/powersync-swift/blob/main/Demos/PowerSyncExample/PowerSyncExample/PowerSync/SystemManager.swift), [.NET](https://github.com/powersync-ja/powersync-dotnet/blob/main/demos/MAUITodo/Data/PowerSyncData.cs), and [Rust](https://github.com/powersync-ja/powersync-native/blob/main/examples/egui_todolist/src/ui.rs) demo apps use this pattern for a refresh action.

## Handling Wait Failures

Expand Down
2 changes: 1 addition & 1 deletion client-sdks/reference/swift.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -361,5 +361,5 @@ See [Supported Platforms -> Swift SDK](/resources/supported-platforms#swift).
Update the version number in `Package.swift` or via Xcode Package Dependencies as documented in the installation instructions: [Installation](/client-sdks/reference/swift#installation).

<Warning>
**Upgrading to v1.14**: This release removes the internal Kotlin dependency and re-implements the SQLite connection pool logic natively in Swift. The public API is unchanged, but the internals are a full rewrite. We recommend testing queries in your app after upgrading to this version.
**Upgrading to v1.14**: This release removes the internal Kotlin dependency and re-implements the SQLite connection pool logic natively in Swift. The public API is unchanged, except that `CrudBatch`, `CrudEntry`, and `CrudTransaction` are now structs that you cannot create in your own code, for example in tests or mocks. The internals are a full rewrite, so we recommend testing queries in your app after upgrading to this version.
</Warning>
Loading
Loading