From ecad57d0da00df1b96fe359b05717c9093a225db Mon Sep 17 00:00:00 2001 From: Shaheem Niyaz Date: Mon, 10 Nov 2025 11:01:35 +0530 Subject: [PATCH 1/2] docs: Fix typos and formatting in markdown files --- docs/ADMIN_API.md | 2 +- docs/DOCKER.md | 2 +- docs/USER_GUIDE.md | 9 +++++---- libsql-server/perf/pgbench/README.md | 2 +- libsql-sqlite3/doc/testrunner.md | 2 +- 5 files changed, 9 insertions(+), 8 deletions(-) diff --git a/docs/ADMIN_API.md b/docs/ADMIN_API.md index 118274a5ec..d5a7fe2478 100644 --- a/docs/ADMIN_API.md +++ b/docs/ADMIN_API.md @@ -6,7 +6,7 @@ The admin API is used to manage namespaces on a `sqld` instance. Namespaces are To enable the admin API, and manage namespaces, two extra flags need to be passed to `sqld`: -- `--admin-listen-addr :`: the address and port on which the admin API should listen. It must be different from the user API listen address (whi defaults to port 8080). +- `--admin-listen-addr :`: the address and port on which the admin API should listen. It must be different from the user API listen address (which defaults to port 8080). - `--enable-namespaces`: enable namespaces for the instance. By default namespaces are disabled. ## Routes diff --git a/docs/DOCKER.md b/docs/DOCKER.md index aeb944c686..a336c0b503 100644 --- a/docs/DOCKER.md +++ b/docs/DOCKER.md @@ -17,7 +17,7 @@ docker run --name some-sqld-replica -p 8081:8080 -ti \ -e SQLD_NODE=replica \ -e SQLD_PRIMARY_URL=https://: \ ghcr.io/tursodatabase/libsql-server:latest -```` +``` ## Running on Apple Silicon diff --git a/docs/USER_GUIDE.md b/docs/USER_GUIDE.md index 615ecab5ca..d23892bc80 100644 --- a/docs/USER_GUIDE.md +++ b/docs/USER_GUIDE.md @@ -25,6 +25,7 @@ Welcome to the `sqld` user guide! The `sqld` program provides libsql over HTTP and supports transparent replication. ![libsql cluster overview.](sqld-overview.png) +

Figure 1. Overview of libsql clustering.

@@ -82,7 +83,7 @@ You now have a `sqld` primary server listening to SQL over HTTP at `127.0.0.1:80 ### Launching a replica server -To start a a `sqld` server in replica mode, run: +To start a `sqld` server in replica mode, run: ```console sqld \ @@ -150,7 +151,7 @@ curl -X POST -d '{"statements": ["select * from testme"]}' $YOUR_APP.fly.dev ``` ```json -[{"b":2,"a":1,"c":3}] +[{ "b": 2, "a": 1, "c": 3 }] ``` ## Incremental snapshots @@ -182,7 +183,7 @@ and then configure `sqld` to generate an incremental snapshot every 5 seconds an sqld --snapshot-exec ./snapshot.sh --max-log-duration 5 ``` -When you write to the `sqld` database, you will eventually see log line such as: +When you write to the `sqld` database, you will eventually see a log line such as: ```console 2023-08-11T08:21:04.183564Z INFO sqld::replication::snapshot: snapshot `e126f594-90f4-45be-9350-bc8a01160de9-0-2.snap` successfully created @@ -254,7 +255,7 @@ For example, if you have the following entries in your `/etc/hosts` file: 127.0.0.1 db2.local ``` -You can access `db1` with the `http://db1.local:8080`URL and `db2` with `http://db2.local:8080`. +You can access `db1` with the `http://db1.local:8080` URL and `db2` with `http://db2.local:8080`. The database files for the databases are stored in `/dbs/db1` and ` Date: Mon, 10 Nov 2025 11:02:42 +0530 Subject: [PATCH 2/2] docs: Remove obsolete version field --- docs/DOCKER.md | 1 - 1 file changed, 1 deletion(-) diff --git a/docs/DOCKER.md b/docs/DOCKER.md index a336c0b503..17a1ade208 100644 --- a/docs/DOCKER.md +++ b/docs/DOCKER.md @@ -122,7 +122,6 @@ inter-node communication. Recommended to leave this on default. Simple docker compose for local development: ```yaml -version: "3" services: db: image: ghcr.io/tursodatabase/libsql-server:latest