Skip to content

Commit b600a06

Browse files
authored
Polish (#132)
* Polish * Update usage/lifecycle-maintenance/upgrading-the-client-sdk.mdx
1 parent baac7be commit b600a06

File tree

15 files changed

+33
-29
lines changed

15 files changed

+33
-29
lines changed

client-sdk-references/javascript-web/javascript-spa-frameworks.mdx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@ title: "JavaScript SPA Frameworks"
33
description: "Compatibility with SPA frameworks"
44
---
55

6-
The PowerSync [JavaScript/Web SDK](../javascript-web) is compatible with popular Single-Page Application (SPA) frameworks like React, Vue, Angular, and Svelte. For [React](#react-hooks) and [Vue](#vue-composables) specifically, wrapper packages are available to support reactivity and live queries, making it easier for developers to leverage PowerSync's features.
6+
The PowerSync [JavaScript Web SDK](../javascript-web) is compatible with popular Single-Page Application (SPA) frameworks like React, Vue, Angular, and Svelte. For [React](#react-hooks) and [Vue](#vue-composables) specifically, wrapper packages are available to support reactivity and live queries, making it easier for developers to leverage PowerSync's features.
77

88
PowerSync also integrates with [TanStack Query for React](#tanstack-query) (details below). This integration provides a wide range of developer tools and paves the way for future live query support in other frameworks.
99

client-sdk-references/react-native-and-expo/react-native-web-support.mdx

Lines changed: 5 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,11 @@ title: "React Native Web Support"
44

55
[React Native for Web](https://necolas.github.io/react-native-web/) enables developers to use the same React Native codebase for both mobile and web platforms.
66

7-
Support for React Native Web is available since versions 1.12.1 of the [PowerSync React Native SDK](/client-sdk-references/react-native-and-expo) and 1.8.0 if the [JavaScript/Web SDK](/client-sdk-references/javascript-web), and is currently in a **beta** release.
7+
<Note>
8+
**Availability**
9+
10+
Support for React Native Web is available since versions 1.12.1 of the PowerSync [React Native SDK](/client-sdk-references/react-native-and-expo) and 1.8.0 if the [JavaScript Web SDK](/client-sdk-references/javascript-web), and is currently in a **beta** release.
11+
</Note>
812

913
A demo app showcasing this functionality is available here:
1014

installation/client-side-setup.mdx

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -18,7 +18,7 @@ The next step after configuring your database and connecting it to your PowerSyn
1818

1919
2. Write mutations to your backend
2020

21-
PowerSync currently supports apps built in [Flutter](/client-sdk-references/flutter), [React Native & Expo](/client-sdk-references/react-native-and-expo), [JavaScript Web](/client-sdk-references/javascript-web), [Kotlin Multiplatform](/client-sdk-references/kotlin-multiplatform) (beta), and [Swift](/client-sdk-references/swift) (beta).
21+
PowerSync currently supports apps built in [Flutter](/client-sdk-references/flutter), [React Native & Expo](/client-sdk-references/react-native-and-expo), [JavaScript Web](/client-sdk-references/javascript-web), [Node.js](/client-sdk-references/node) (alpha), [Kotlin Multiplatform](/client-sdk-references/kotlin-multiplatform) (beta), [Swift](/client-sdk-references/swift) (beta), and [.NET](/client-sdk-references/dotnet) (closed alpha).
2222

2323
Please see the steps based on your app framework:
2424

@@ -83,8 +83,8 @@ Please see the steps based on your app framework:
8383
<Card title="React Native & Expo" icon="react" href="/client-sdk-references/react-native-and-expo" horizontal />
8484
</Accordion>
8585

86-
<Accordion title="JavaScript/Web" icon="js">
87-
Add the [PowerSync JavaScript Web NPM package](https://www.npmjs.com/package/@powersync/web) to your project:
86+
<Accordion title="JavaScript Web" icon="js">
87+
Add the [PowerSync Web NPM package](https://www.npmjs.com/package/@powersync/web) to your project:
8888

8989
<Tabs>
9090
<Tab title="npm">

installation/client-side-setup/define-your-schema.mdx

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -27,11 +27,11 @@ For an example implementation of the client-side schema, see the _Getting Starte
2727

2828
* [1\. Define the Schema](/client-sdk-references/react-native-and-expo#1-define-the-schema)
2929

30-
### <Icon icon="js" iconType="solid" size="24"/> JavaScript/Web
30+
### <Icon icon="js" iconType="solid" size="24"/> JavaScript Web
3131

3232
* [1\. Define the Schema](/client-sdk-references/javascript-web#1-define-the-schema)
3333

34-
### <Icon icon="node-js" iconType="solid" size="24"/> JavaScript/Node.js (alpha)
34+
### <Icon icon="node-js" iconType="solid" size="24"/> Node.js (alpha)
3535

3636
* [1\. Define the Schema](/client-sdk-references/node#1-define-the-schema)
3737

installation/client-side-setup/instantiate-powersync-database.mdx

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -17,11 +17,11 @@ For an example implementation of instantiating the client-side database, see the
1717

1818
* [2\. Instantiate the PowerSync Database](/client-sdk-references/react-native-and-expo#2-instantiate-the-powersync-database)
1919

20-
### <Icon icon="js" iconType="solid" size="24"/> JavaScript/Web
20+
### <Icon icon="js" iconType="solid" size="24"/> JavaScript Web
2121

2222
* [2\. Instantiate the PowerSync Database](/client-sdk-references/javascript-web#2-instantiate-the-powersync-database)
2323

24-
### <Icon icon="node-js" iconType="solid" size="24"/> JavaScript/Node.js (alpha)
24+
### <Icon icon="node-js" iconType="solid" size="24"/> Node.js (alpha)
2525

2626
* [2\. Instantiate the PowerSync Database](/client-sdk-references/node#2-instantiate-the-powersync-database)
2727

installation/client-side-setup/integrating-with-your-backend.mdx

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -27,11 +27,11 @@ For an example implementation of a PowerSync 'backend connector', see the _Getti
2727

2828
* [3\. Integrate with your Backend](/client-sdk-references/react-native-and-expo#3-integrate-with-your-backend)
2929

30-
### <Icon icon="js" iconType="solid" size="24"/> JavaScript/Web
30+
### <Icon icon="js" iconType="solid" size="24"/> JavaScript Web
3131

3232
* [3\. Integrate with your Backend](/client-sdk-references/javascript-web#3-integrate-with-your-backend)
3333

34-
### <Icon icon="node-js" iconType="solid" size="24"/> JavaScript/Node.js (alpha)
34+
### <Icon icon="node-js" iconType="solid" size="24"/> Node.js (alpha)
3535

3636
* [3\. Integrate with your Backend](/client-sdk-references/node#3-integrate-with-your-backend)
3737

installation/quickstart-guide.mdx

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -6,8 +6,8 @@ sidebarTitle: "Quickstart / Overview"
66
PowerSync is designed to be stack agnostic, and currently supports **Postgres**, **MongoDB** and **MySQL** (alpha) as the source database, and has the following official client-side SDKs available today:
77
- [**Flutter**](/client-sdk-references/flutter) (mobile and [web](/client-sdk-references/flutter/flutter-web-support))
88
- [**React Native**](/client-sdk-references/react-native-and-expo) (mobile and [web](/client-sdk-references/react-native-and-expo/react-native-web-support))
9-
- [**JavaScript/Web**](/client-sdk-references/javascript-web) (vanilla JS, React, Vue)
10-
- [**JavaScript/Node.js**](/client-sdk-references/node) (alpha)
9+
- [**JavaScript Web**](/client-sdk-references/javascript-web) (vanilla JS, React, Vue)
10+
- [**Node.js**](/client-sdk-references/node) (alpha)
1111
- [**Kotlin Multiplatform**](/client-sdk-references/kotlin-multiplatform) (beta)
1212
- [**Swift**](/client-sdk-references/swift) (beta)
1313
- [**.NET**](/client-sdk-references/dotnet) (closed alpha)

integration-guides/supabase-+-powersync.mdx

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
---
22
title: "Supabase + PowerSync"
3-
description: "Tutorial-style integration guide for creating offline-first apps with Supabase and PowerSync, using a demo to-do list app in Flutter, React Native, JavaScript Web, Kotlin Multiplatform and Swift."
3+
description: "Tutorial-style integration guide for creating offline-first apps with Supabase and PowerSync, using a demo to-do list app in Flutter, React Native, Web, Kotlin Multiplatform and Swift."
44
sidebarTitle: Overview
55
---
66

@@ -171,7 +171,7 @@ git clone https://github.com/powersync-ja/powersync-js.git
171171
cd powersync-js/demos/react-native-supabase-todolist
172172
```
173173

174-
```bash JavaScript/Web
174+
```bash JavaScript Web
175175
git clone https://github.com/powersync-ja/powersync-js.git
176176
cd powersync-js/demos/react-supabase-todolist
177177
```
@@ -207,7 +207,7 @@ cp lib/app_config_template.dart lib/app_config.dart
207207
# Edit the `.env` file and insert the necessary credentials as detailed below.
208208
```
209209

210-
```bash JavaScript/Web
210+
```bash JavaScript Web
211211
cp .env.local.template .env.local
212212

213213
# Edit `.env.local` and insert the necessary credentials as detailed below.
@@ -262,7 +262,7 @@ pnpm ios
262262
pnpm android
263263
```
264264

265-
```bash JavaScript/Web
265+
```bash JavaScript Web
266266
# In the repo root directory:
267267
pnpm install
268268
pnpm build:packages

resources/demo-apps-example-projects.mdx

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -46,7 +46,7 @@ Example projects are listed under backend they use, but you can easily wire up y
4646
* Corresponding backend demo: [Django Backend for To-Do List App](https://github.com/powersync-ja/powersync-django-backend-todolist-demo) (also linked below)
4747
</Accordion>
4848

49-
<Accordion title="JavaScript/Web" icon="js">
49+
<Accordion title="JavaScript Web" icon="js">
5050
#### Supabase Backend:
5151
* [React To-Do List App](https://github.com/powersync-ja/powersync-js/tree/main/demos/react-supabase-todolist)
5252
* Includes [Full-Text Search](/usage/use-case-examples/full-text-search) (FTS) example
@@ -65,7 +65,7 @@ Example projects are listed under backend they use, but you can easily wire up y
6565
* [example-vite](https://github.com/powersync-ja/powersync-js/blob/main/demos/example-vite/README.md): A minimal example demonstrating bundling with [Vite](https://vitejs.dev/).
6666
</Accordion>
6767

68-
<Accordion title="JavaScript/Node.js (alpha)" icon="node-js">
68+
<Accordion title="Node.js (alpha)" icon="node-js">
6969
#### Self-Hosted:
7070
* [CLI example](https://github.com/powersync-ja/powersync-js/tree/main/demos/example-node)
7171
</Accordion>

resources/troubleshooting.mdx

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -81,9 +81,9 @@ These are some common pointers when it comes to diagnosing and understanding per
8181
2. The **initial sync** on a client can take a while in cases where the operations history is large. See [Compacting Buckets](/usage/lifecycle-maintenance/compacting-buckets) to optimizes sync performance.
8282
3. You can get big performance gains by using **transactions & batching** as explained in this [blog post](https://www.powersync.com/blog/flutter-database-comparison-sqlite-async-sqflite-objectbox-isar).
8383

84-
### JavaScript Web: Logging queries on the performance timeline
84+
### Web: Logging queries on the performance timeline
8585

86-
Enabling the `debugMode` flag in the [JavaScript Web SDK](/client-sdk-references/javascript-web) logs all SQL queries on the Performance timeline in Chrome's Developer Tools (after recording). This can help identify slow-running queries.
86+
Enabling the `debugMode` flag in the [Web SDK](/client-sdk-references/javascript-web) logs all SQL queries on the Performance timeline in Chrome's Developer Tools (after recording). This can help identify slow-running queries.
8787
<Frame>
8888
<img src="/images/resources/performance-timeline.png"/>
8989
</Frame>

0 commit comments

Comments
 (0)