From 859766ba0b4b0d96432929c7c756033d11bb5408 Mon Sep 17 00:00:00 2001 From: Qinren Zhou Date: Wed, 21 Oct 2026 14:28:43 +0800 Subject: [PATCH 1/7] docs: clarify README platforms and Python example --- README.md | 7 +++++-- README_CN.md | 6 ++++-- 2 files changed, 9 insertions(+), 4 deletions(-) diff --git a/README.md b/README.md index ddb5795f79..6d98aecc15 100644 --- a/README.md +++ b/README.md @@ -76,8 +76,10 @@ Prefer a visual tool? Try **[Zvec Studio](https://github.com/zvec-ai/zvec-studio ### ✅ Supported Platforms -Zvec supports all major platforms, including **Linux, macOS, and Windows**; see -the [platform support documentation](https://zvec.org/en/docs/db/platforms/) for details. +**Linux · macOS · Windows · Android · iOS** + +See [platform compatibility](https://zvec.org/en/docs/db/platforms/) +for supported architectures, SDKs, and index availability. ### 🛠️ Building from Source @@ -86,6 +88,7 @@ If you prefer to build Zvec from source, please check the [Building from Source] ## ⚡ One-Minute Example ```python +# Zvec Python SDK — quickstart example import zvec # Define collection schema diff --git a/README_CN.md b/README_CN.md index e8ff8c2db2..884c915f79 100644 --- a/README_CN.md +++ b/README_CN.md @@ -79,8 +79,9 @@ Zvec 提供多语言官方 SDK： ### ✅ 支持的平台 -Zvec 支持 **Linux、macOS、Windows** -等主流平台，完整兼容性信息请参阅[全平台支持文档](https://zvec.org/zh/docs/db/platforms/)。 +**Linux · macOS · Windows · Android · iOS** + +有关支持的架构、SDK 和索引类型，请参阅[平台兼容性文档](https://zvec.org/zh/docs/db/platforms/)。 ### 🛠️ 源码构建 @@ -89,6 +90,7 @@ Zvec 支持 **Linux、macOS、Windows** ## ⚡ 一分钟上手 ```python +# Zvec Python SDK — 快速入门示例 import zvec # 定义 collection schema From 65fb24670dc51e0a191a9588168408d86b3ef887 Mon Sep 17 00:00:00 2001 From: Qinren Zhou Date: Wed, 21 Oct 2026 14:45:09 +0800 Subject: [PATCH 2/7] docs: simplify README platform headings and links --- README.md | 5 ++--- README_CN.md | 4 ++-- 2 files changed, 4 insertions(+), 5 deletions(-) diff --git a/README.md b/README.md index 6d98aecc15..24a088663c 100644 --- a/README.md +++ b/README.md @@ -74,12 +74,11 @@ Searching code or documents? Try **[zvec-grep](https://github.com/zvec-ai/zvec-g Prefer a visual tool? Try **[Zvec Studio](https://github.com/zvec-ai/zvec-studio)** to browse data and debug queries — no code required. -### ✅ Supported Platforms +### 🌍 Cross-Platform Support **Linux · macOS · Windows · Android · iOS** -See [platform compatibility](https://zvec.org/en/docs/db/platforms/) -for supported architectures, SDKs, and index availability. +[Platform details →](https://zvec.org/en/docs/db/platforms/) ### 🛠️ Building from Source diff --git a/README_CN.md b/README_CN.md index 884c915f79..5039135e74 100644 --- a/README_CN.md +++ b/README_CN.md @@ -77,11 +77,11 @@ Zvec 提供多语言官方 SDK： 想要图形界面？试试 **[Zvec Studio](https://github.com/zvec-ai/zvec-studio)**，零代码浏览数据与调试查询。 -### ✅ 支持的平台 +### 🌍 全平台支持 **Linux · macOS · Windows · Android · iOS** -有关支持的架构、SDK 和索引类型，请参阅[平台兼容性文档](https://zvec.org/zh/docs/db/platforms/)。 +[查看平台详情 →](https://zvec.org/zh/docs/db/platforms/) ### 🛠️ 源码构建 From 9ecf2dbc4fb41c524b14fd49434e78b0ea122333 Mon Sep 17 00:00:00 2001 From: Qinren Zhou Date: Wed, 21 Oct 2026 14:48:28 +0800 Subject: [PATCH 3/7] docs: restore platform section checkmark emoji --- README.md | 2 +- README_CN.md | 2 +- 2 files changed, 2 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index 24a088663c..b277b52e8e 100644 --- a/README.md +++ b/README.md @@ -74,7 +74,7 @@ Searching code or documents? Try **[zvec-grep](https://github.com/zvec-ai/zvec-g Prefer a visual tool? Try **[Zvec Studio](https://github.com/zvec-ai/zvec-studio)** to browse data and debug queries — no code required. -### 🌍 Cross-Platform Support +### ✅ Cross-Platform Support **Linux · macOS · Windows · Android · iOS** diff --git a/README_CN.md b/README_CN.md index 5039135e74..032a87b954 100644 --- a/README_CN.md +++ b/README_CN.md @@ -77,7 +77,7 @@ Zvec 提供多语言官方 SDK： 想要图形界面？试试 **[Zvec Studio](https://github.com/zvec-ai/zvec-studio)**，零代码浏览数据与调试查询。 -### 🌍 全平台支持 +### ✅ 全平台支持 **Linux · macOS · Windows · Android · iOS** From 272f2b36bccbf10ebd028e1cf75d8be2f1b25124 Mon Sep 17 00:00:00 2001 From: Qinren Zhou Date: Wed, 21 Oct 2026 14:50:02 +0800 Subject: [PATCH 4/7] docs: describe cross-platform application use cases --- README.md | 1 + README_CN.md | 1 + 2 files changed, 2 insertions(+) diff --git a/README.md b/README.md index b277b52e8e..d06cf5219f 100644 --- a/README.md +++ b/README.md @@ -78,6 +78,7 @@ Prefer a visual tool? Try **[Zvec Studio](https://github.com/zvec-ai/zvec-studio **Linux · macOS · Windows · Android · iOS** +Embed Zvec in server, desktop, and mobile applications. [Platform details →](https://zvec.org/en/docs/db/platforms/) ### 🛠️ Building from Source diff --git a/README_CN.md b/README_CN.md index 032a87b954..d06ab0e1c9 100644 --- a/README_CN.md +++ b/README_CN.md @@ -81,6 +81,7 @@ Zvec 提供多语言官方 SDK： **Linux · macOS · Windows · Android · iOS** +将 Zvec 嵌入服务端、桌面或移动应用。 [查看平台详情 →](https://zvec.org/zh/docs/db/platforms/) ### 🛠️ 源码构建 From 99ef21e9517f21b3fc944ec11e86fc866b94a1f0 Mon Sep 17 00:00:00 2001 From: Qinren Zhou Date: Wed, 21 Oct 2026 14:53:10 +0800 Subject: [PATCH 5/7] docs: separate platform links and clarify link labels --- README.md | 4 ++-- README_CN.md | 4 ++-- 2 files changed, 4 insertions(+), 4 deletions(-) diff --git a/README.md b/README.md index d06cf5219f..c80eb1e63b 100644 --- a/README.md +++ b/README.md @@ -78,8 +78,8 @@ Prefer a visual tool? Try **[Zvec Studio](https://github.com/zvec-ai/zvec-studio **Linux · macOS · Windows · Android · iOS** -Embed Zvec in server, desktop, and mobile applications. -[Platform details →](https://zvec.org/en/docs/db/platforms/) +Embed Zvec in server, desktop, and mobile applications.
+[Platform Support and Compatibility](https://zvec.org/en/docs/db/platforms/) ### 🛠️ Building from Source diff --git a/README_CN.md b/README_CN.md index d06ab0e1c9..ac13717009 100644 --- a/README_CN.md +++ b/README_CN.md @@ -81,8 +81,8 @@ Zvec 提供多语言官方 SDK： **Linux · macOS · Windows · Android · iOS** -将 Zvec 嵌入服务端、桌面或移动应用。 -[查看平台详情 →](https://zvec.org/zh/docs/db/platforms/) +将 Zvec 嵌入服务端、桌面或移动应用。
+[平台支持与兼容性说明](https://zvec.org/zh/docs/db/platforms/) ### 🛠️ 源码构建 From 5923b319ad6a3f34d8aee365f8b6a338f5a06a3f Mon Sep 17 00:00:00 2001 From: Qinren Zhou Date: Wed, 21 Oct 2026 14:57:50 +0800 Subject: [PATCH 6/7] docs: refine cross-platform support wording --- README.md | 4 ++-- README_CN.md | 4 ++-- 2 files changed, 4 insertions(+), 4 deletions(-) diff --git a/README.md b/README.md index c80eb1e63b..6cb735a934 100644 --- a/README.md +++ b/README.md @@ -78,8 +78,8 @@ Prefer a visual tool? Try **[Zvec Studio](https://github.com/zvec-ai/zvec-studio **Linux · macOS · Windows · Android · iOS** -Embed Zvec in server, desktop, and mobile applications.
-[Platform Support and Compatibility](https://zvec.org/en/docs/db/platforms/) +Zvec supports all major platforms — from servers and desktops to mobile devices.
+For more details, please see the [platform support documentation](https://zvec.org/en/docs/db/platforms/). ### 🛠️ Building from Source diff --git a/README_CN.md b/README_CN.md index ac13717009..9072729f8d 100644 --- a/README_CN.md +++ b/README_CN.md @@ -81,8 +81,8 @@ Zvec 提供多语言官方 SDK： **Linux · macOS · Windows · Android · iOS** -将 Zvec 嵌入服务端、桌面或移动应用。
-[平台支持与兼容性说明](https://zvec.org/zh/docs/db/platforms/) +Zvec 提供全平台支持，覆盖服务器、桌面和移动设备。
+如需了解更多细节，请查阅[平台支持文档](https://zvec.org/zh/docs/db/platforms/)。 ### 🛠️ 源码构建 From e3662b56de4de0ed7ccd2e57670d0d75d1b05e24 Mon Sep 17 00:00:00 2001 From: Qinren Zhou Date: Wed, 21 Oct 2026 15:12:01 +0800 Subject: [PATCH 7/7] docs: identify Python examples in README headings --- README.md | 3 +-- README_CN.md | 3 +-- 2 files changed, 2 insertions(+), 4 deletions(-) diff --git a/README.md b/README.md index 6cb735a934..f779b1d168 100644 --- a/README.md +++ b/README.md @@ -85,10 +85,9 @@ For more details, please see the [platform support documentation](https://zvec.o If you prefer to build Zvec from source, please check the [Building from Source](https://zvec.org/en/docs/db/build/) guide. -## ⚡ One-Minute Example +## ⚡ One-Minute Python Example ```python -# Zvec Python SDK — quickstart example import zvec # Define collection schema diff --git a/README_CN.md b/README_CN.md index 9072729f8d..67f9f8daac 100644 --- a/README_CN.md +++ b/README_CN.md @@ -88,10 +88,9 @@ Zvec 提供全平台支持，覆盖服务器、桌面和移动设备。
如需从源码构建 Zvec，请参考[源码构建指南](https://zvec.org/zh/docs/db/build/)。 -## ⚡ 一分钟上手 +## ⚡ 一分钟上手（Python） ```python -# Zvec Python SDK — 快速入门示例 import zvec # 定义 collection schema