Skip to content

Commit 9288748

Browse files
committed
chore: organize docs folder
1 parent 1d227fd commit 9288748

File tree

18 files changed

+14
-14
lines changed

18 files changed

+14
-14
lines changed

API.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -57,7 +57,7 @@ When designing your database schema for SQLite Sync, follow these essential requ
5757
- **Foreign Key Compatibility**: Be aware of potential conflicts during CRDT merge operations and RLS policy interactions.
5858
- **Trigger Compatibility**: Triggers may cause duplicate operations or be called multiple times due to column-by-column processing.
5959

60-
For comprehensive guidelines, see the [Database Schema Recommendations](docs/SCHEMA.md).
60+
For comprehensive guidelines, see the [Database Schema Recommendations](docs/schema.md).
6161

6262
The function supports three overloads:
6363
- `cloudsync_init(table_name)`: Uses the default 'cls' CRDT algorithm.

README.md

Lines changed: 8 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -53,7 +53,7 @@ Built on **CRDT** (Conflict-free Replicated Data Types), it guarantees:
5353

5454
### 1. Install
5555

56-
Download a pre-built binary from the [Releases](https://github.com/sqliteai/sqlite-sync/releases) page, or install a platform package (see [full installation guide](./docs/INSTALLATION.md) for platform-specific code examples):
56+
Download a pre-built binary from the [Releases](https://github.com/sqliteai/sqlite-sync/releases) page, or install a platform package (see [full installation guide](./docs/installation.md) for platform-specific code examples):
5757

5858
| Platform | Install |
5959
|----------|---------|
@@ -165,7 +165,7 @@ SELECT cloudsync_init('notes');
165165
SELECT cloudsync_set_column('notes', 'body', 'algo', 'block');
166166
```
167167

168-
Now two agents (or devices) can edit different lines of the same note, and both edits are preserved after sync. See the full guide: **[Block-Level LWW Documentation](./docs/BLOCK-LWW.md)**.
168+
Now two agents (or devices) can edit different lines of the same note, and both edits are preserved after sync. See the full guide: **[Block-Level LWW Documentation](./docs/block-lww.md)**.
169169

170170
## Row-Level Security
171171

@@ -174,16 +174,16 @@ With SQLite Cloud's RLS, a single shared cloud database serves all users while e
174174
- One database, multiple tenants, no per-user database provisioning.
175175
- Each client syncs only authorized rows, minimal bandwidth and storage.
176176

177-
See the full guide: **[Row-Level Security Documentation](./docs/ROW-LEVEL-SECURITY.md)**.
177+
See the full guide: **[Row-Level Security Documentation](./docs/row-level-security.md)**.
178178

179179
## Documentation
180180

181181
- **[API Reference](./API.md)**: all functions, parameters, and examples
182-
- **[Installation Guide](./docs/INSTALLATION.md)**: platform-specific setup (Swift, Android, Expo, React Native, Flutter, WASM)
183-
- **[Block-Level LWW Guide](./docs/BLOCK-LWW.md)**: line-level text merge for markdown and documents
184-
- **[Row-Level Security Guide](./docs/ROW-LEVEL-SECURITY.md)**: multi-tenant access control with server-enforced policies
185-
- **[Database Schema Recommendations](./docs/SCHEMA.md)**: primary keys, constraints, foreign keys, triggers
186-
- **[Custom Network Layer](./docs/Network.md)**: replace the built-in libcurl networking
182+
- **[Installation Guide](./docs/installation.md)**: platform-specific setup (Swift, Android, Expo, React Native, Flutter, WASM)
183+
- **[Block-Level LWW Guide](./docs/block-lww.md)**: line-level text merge for markdown and documents
184+
- **[Row-Level Security Guide](./docs/row-level-security.md)**: multi-tenant access control with server-enforced policies
185+
- **[Database Schema Recommendations](./docs/schema.md)**: primary keys, constraints, foreign keys, triggers
186+
- **[Custom Network Layer](./docs/internal/network.md)**: replace the built-in libcurl networking
187187
- **[Examples](./examples/)**: complete walkthroughs (todo app, sport tracker, Swift multiplatform)
188188

189189
## SQLite Cloud Setup

docs/ROW-LEVEL-SECURITY.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -44,6 +44,6 @@ CREATE TABLE users (
4444
);
4545
```
4646

47-
For more schema guidelines, see [Database Schema Recommendations](./SCHEMA.md).
47+
For more schema guidelines, see [Database Schema Recommendations](./schema.md).
4848

4949
For full RLS documentation, see the [SQLite Cloud RLS documentation](https://docs.sqlitecloud.io/docs/rls).
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.

docs/postgresql/README.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -67,7 +67,7 @@ Additional CRDTs can be implemented if needed, though LWW covers most real-world
6767

6868
### Observability
6969

70-
* Metrics dashboard available in [grafana-dashboard.json](grafana-dashboard.json)
70+
* Metrics dashboard available in [grafana-dashboard.json](../internal/grafana-dashboard.json)
7171

7272

7373
# Postgres Sync
@@ -97,6 +97,6 @@ The PostgreSQL integration is actively evolving. Current limitations include:
9797
* **Beta Status**: While extensively tested, the PostgreSQL sync stack should currently be considered **beta software**. Please report any issues; we are committed to resolving them quickly.
9898

9999
# Next
100-
* [CLIENT](CLIENT.md) installation and setup
101-
* [SUPABASE](SUPABASE.md) configuration and setup
102-
* [SPORT-TRACKER APP](SPORT_APP_README_SUPABASE.md) demo web app based on SQLite Sync WASM
100+
* [CLIENT](client.md) installation and setup
101+
* [SUPABASE](integrations/supabase.md) configuration and setup
102+
* [SPORT-TRACKER APP](examples/sport-app-supabase.md) demo web app based on SQLite Sync WASM
File renamed without changes.

0 commit comments

Comments
 (0)