Skip to content

Commit 060837e

Browse files
docs: fix heading case and terminology consistency (#488)
Co-authored-by: mintlify[bot] <109931778+mintlify[bot]@users.noreply.github.com>
1 parent 7eb9650 commit 060837e

5 files changed

Lines changed: 13 additions & 11 deletions

File tree

client-sdks/advanced/attachments.mdx

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -61,7 +61,7 @@ Most demo applications use Supabase Storage as the storage provider, but the pat
6161
|-------|-------------|
6262
| `QUEUED_UPLOAD` | File saved locally, waiting to upload to remote storage |
6363
| `QUEUED_DOWNLOAD` | Data model synced from another device, file needs to be downloaded |
64-
| `SYNCED` | File exists both locally and in remote storage, fully synchronized |
64+
| `SYNCED` | File exists both locally and in remote storage, fully synced |
6565
| `QUEUED_DELETE` | Marked for deletion from both local and remote storage |
6666
| `ARCHIVED` | No longer referenced in your data model, candidate for cleanup |
6767

@@ -141,7 +141,7 @@ The queue needs to know which attachments exist in your data model. The `watchAt
141141
- **Missing attachments** - Upload them
142142
- **Removed attachments** - Archive them
143143

144-
The `watchAttachments` queries are reactive and execute whenever the watched tables change, keeping the attachment queue synchronized with your data model.
144+
The `watchAttachments` queries are reactive and execute whenever the watched tables change, keeping the attachment queue in sync with your data model.
145145

146146
There are a few scenarios you might encounter:
147147

client-sdks/advanced/local-only-usage.mdx

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -11,7 +11,7 @@ A caveat is that if the user never registers, this queue will keep on growing in
1111

1212
There are two general approaches we recommend for this:
1313

14-
### 1\. Local-only tables
14+
### 1\. Local-Only Tables
1515

1616
<Tabs>
1717
<Tab title="Flutter">
@@ -77,7 +77,7 @@ The following example implementations are available:
7777
| Flutter To-Do List App (with Supabase) | [supabase-todolist-optional-sync](https://github.com/powersync-ja/powersync.dart/tree/main/demos/supabase-todolist-optional-sync) |
7878
| React To-Do List App (with Supabase) | [react-supabase-todolist-optional-sync](https://github.com/powersync-ja/powersync-js/tree/main/demos/react-supabase-todolist-optional-sync) |
7979

80-
### 2\. Clearing the upload queue
80+
### 2\. Clearing the Upload Queue
8181

8282
The upload queue can be cleared periodically (for example on every app start-up), avoiding the growth in database size over time. This can be done using:
8383

client-sdks/advanced/sequential-id-mapping.mdx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -90,7 +90,7 @@ We can achieve this by creating SQL triggers.
9090
## Create SQL Triggers
9191

9292
We need to create triggers that can look up the integer ID for the given UUID and vice versa.
93-
These triggers will maintain consistency between `list_id` and `list_uuid` in the `todos` table by ensuring that they remain synchronized with the `id` and `uuid` columns in the `lists` table;
93+
These triggers will maintain consistency between `list_id` and `list_uuid` in the `todos` table by ensuring that they remain in sync with the `id` and `uuid` columns in the `lists` table;
9494
even if changes are made to either field.
9595

9696
We will create the following two triggers that cover either scenario of updating the `list_id` or `list_uuid` in the `todos` table:

client-sdks/advanced/unit-testing.mdx

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -65,7 +65,9 @@ test('INSERT', () async {
6565
});
6666
```
6767

68-
#### If you have trouble with loading the extension, confirm the following
68+
### Troubleshooting Extension Loading
69+
70+
If you have trouble loading the extension, confirm the following:
6971

7072
Ensure that your SQLite3 binary install on your system has extension loading enabled. You can confirm this by doing the following
7173

sync/advanced/sharded-databases.mdx

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -20,27 +20,27 @@ Where feasible, using separate PowerSync Service instances would give better per
2020

2121
Some specific scenarios:
2222

23-
#### 1\. Different tables on different databases
23+
#### 1\. Different Tables on Different Databases
2424

2525
This is common when separate "services" use separate databases, but multiple tables across those databases need to be synced to the same users.
2626

2727
Use a single PowerSync Service instance, with a separate connection for each source database ([planned](https://roadmap.powersync.com/c/84-support-for-sharding-multiple-database-connections); this capability will be available in a future release). Use a unique [connection tag](/sync/advanced/schemas-and-connections) for each source database, allowing them to be distinguished in your [Sync Streams](/sync/streams/overview) or [Sync Rules](/sync/rules/overview).
2828

29-
#### 2a. All data for any single customer is contained in a single shard
29+
#### 2a. All Data for a Single Customer Is Contained in a Single Shard
3030

3131
This is common when sharding per customer account / organization.
3232

3333
In this case, use a separate PowerSync Service instance for each database.
3434

35-
#### 2b. Most customer data is in a single shard, but some data is in a shared database
35+
#### 2b. Most Customer Data Is in a Single Shard, but Some Data Is in a Shared Database
3636

3737
If the amount of shared data is small, still use a separate PowerSync Service instance for each database, but also add the shared database connection to each PowerSync Service instance using a separate connection tag ([planned](https://roadmap.powersync.com/c/84-support-for-sharding-multiple-database-connections); this capability will be available in a future release).
3838

39-
#### 2c. Data for a single customer is split across multiple shards
39+
#### 2c. Data for a Single Customer Is Split Across Multiple Shards
4040

4141
This is more complicated than the other cases listed above. Please [reach out to us](/resources/contact-us) if this is your architecture.
4242

43-
#### 3\. Only some tables are sharded
43+
#### 3\. Only Some Tables Are Sharded
4444

4545
In some cases, most tables would be on a shared server, with only a few large tables being sharded.
4646

0 commit comments

Comments
 (0)