Merge pull request #619 from tursodatabase/lucio/docs-client-versions

docs: Move docs to root and add `client_version_metrics.md`
tursodatabase · Nov 15, 2023 · cdbdf67 · cdbdf67
2 parents d1bdddd + bb97992
commit cdbdf67
Show file tree

Hide file tree

Showing 14 changed files with 15 additions and 0 deletions.
diff --git a/libsql-server/docs/BUILD-RUN.md → docs/BUILD-RUN.md b/libsql-server/docs/BUILD-RUN.md → docs/BUILD-RUN.md
diff --git a/libsql-server/docs/CONSISTENCY_MODEL.md → docs/CONSISTENCY_MODEL.md b/libsql-server/docs/CONSISTENCY_MODEL.md → docs/CONSISTENCY_MODEL.md
diff --git a/libsql-server/docs/DESIGN.md → docs/DESIGN.md b/libsql-server/docs/DESIGN.md → docs/DESIGN.md
diff --git a/libsql-server/docs/DOCKER.md → docs/DOCKER.md b/libsql-server/docs/DOCKER.md → docs/DOCKER.md
diff --git a/libsql-server/docs/HRANA_1_SPEC.md → docs/HRANA_1_SPEC.md b/libsql-server/docs/HRANA_1_SPEC.md → docs/HRANA_1_SPEC.md
diff --git a/libsql-server/docs/HRANA_2_SPEC.md → docs/HRANA_2_SPEC.md b/libsql-server/docs/HRANA_2_SPEC.md → docs/HRANA_2_SPEC.md
diff --git a/libsql-server/docs/HRANA_3_SPEC.md → docs/HRANA_3_SPEC.md b/libsql-server/docs/HRANA_3_SPEC.md → docs/HRANA_3_SPEC.md
diff --git a/libsql-server/docs/HTTP_V1_SPEC.md → docs/HTTP_V1_SPEC.md b/libsql-server/docs/HTTP_V1_SPEC.md → docs/HTTP_V1_SPEC.md
diff --git a/libsql-server/docs/HTTP_V2_SPEC.md → docs/HTTP_V2_SPEC.md b/libsql-server/docs/HTTP_V2_SPEC.md → docs/HTTP_V2_SPEC.md
diff --git a/libsql-server/docs/USER_GUIDE.md → docs/USER_GUIDE.md b/libsql-server/docs/USER_GUIDE.md → docs/USER_GUIDE.md
diff --git a/docs/client_version_metrics.md b/docs/client_version_metrics.md
@@ -0,0 +1,15 @@
+# Client verison metrics
+
+Currently, `sqld` supports clients passing their client version via a
+`x-libsql-client-version` header. The value of this header should follow this
+pattern:
+
+- Hrana/Remote clients should be `libsql-remote-<language>-<version>`
+- Embedded replica clients should be `libsql-rpc-<language>-<version>`
+
+
+`<language>` should be a reference to the language, for example,
+`rust`/`go`/`js`/`python`.
+
+`<version>` should be a reference to either a semver version or a commit sha
+(first 6 chars of the sha).
diff --git a/libsql-server/docs/http_api.md → docs/http_api.md b/libsql-server/docs/http_api.md → docs/http_api.md
diff --git a/libsql-server/docs/sqld-overview.excalidraw → docs/sqld-overview.excalidraw b/libsql-server/docs/sqld-overview.excalidraw → docs/sqld-overview.excalidraw
diff --git a/libsql-server/docs/sqld-overview.png → docs/sqld-overview.png b/libsql-server/docs/sqld-overview.png → docs/sqld-overview.png