docs: add platform support page (en/zh) by chinaux · Pull Request #67 · zvec-ai/zvec-web

chinaux · 2026-09-15T12:05:55Z

Add a Platform Support page to the Zvec docs that consolidates:

official language SDKs (Python, Node.js, Go, Rust, Java, Dart/Flutter) with install commands, repositories, and prebuilt platform coverage
CI-verified OS/architecture combinations and prebuilt artifact status, including musl Linux, macOS Intel, Android, iOS, and RISC-V
an index-by-platform availability matrix (Flat, IVF, HNSW, Vamana, sparse, RaBitQ, DiskANN, INVERT, FTS)

Registered in the Introduction section of both en/zh sidebars.

Add a Platform Support page to the Zvec docs that consolidates: - official language SDKs (Python, Node.js, Go, Rust, Java, Dart/Flutter) with install commands, repositories, and prebuilt platform coverage - CI-verified OS/architecture combinations and prebuilt artifact status, including musl Linux, macOS Intel, Android, iOS, and RISC-V - an index-by-platform availability matrix (Flat, IVF, HNSW, Vamana, sparse, RaBitQ, DiskANN, INVERT, FTS) Registered in the Introduction section of both en/zh sidebars.

github-actions · 2026-09-15T12:08:41Z

☁️ Cloudflare Pages preview: https://073a3eba.zvec-web.pages.dev

zhourrr · 2026-09-17T08:07:25Z

感觉页面有点乱，表格太多了。可以参考 duckdb 的风格

https://duckdb.org/install/?platform=macos&environment=nodejs

- Drop the per-SDK notes accordion and the ecosystem tools paragraph to reduce visual density - Fix relative links (./ -> ../) so the index matrix and related cards resolve correctly from the page URL - Point the RaBitQ row's HNSW / IVF labels at the HNSW-RaBitQ and IVF-RaBitQ concept pages

chinaux · 2026-09-18T02:27:58Z

页面定位不同：DuckDB install 是单目标任务页——用户只要"给我当前平台+语言的一条安装命令"，二维选择器是最优解。而 Platform Support 是兼容性参考页，要同时回答三类全局问题：有哪些 SDK 及安装方式、CI 验证了哪些 OS/架构组合且有预编译产物、每类索引在哪些平台可用。
后两类天然是跨平台对比信息，选择器一次只显示一个组合，反而更难用。
表格是矩阵信息的标准载体，不是"乱"：索引可用性是索引×7平台的 8×7 矩阵，CI 验证是平台×架构×验证方式×产物的关系，多对多关系在静态文档里只有表格能一眼扫全。
DuckDB 风格提供的信息本页已有：SDK 表的 Install 列就是安装命令（pip install zvec、npm install @zvec/zvec…），等于选择器的输出；选择器额外只给"过滤"，而本页过滤收益极小（SDK 仅 6 行），代价却是丢掉全局视图。
工程与生态成本：站点文档全是静态 MDX（fumadocs），表格零组件、零维护，且可被搜索引擎、llms.txt、屏幕阅读器、打印和 LLM 直接消费；改交互选择器要写自定义组件并维护一套 per-platform 数据结构，与 benchmarks、quickstart 等全站表格风格割裂。
"乱"可以低成本收敛一下（1ae2c92）：
- 删掉了 per-SDK 补充说明折叠块和生态工具段落，首屏只留 SDK 表 + 平台表 + 索引矩阵，密度明显下降
- 索引矩阵索引添加链接，指向其concept页
- ✅/❌ 增加图例行，避免歧义

zhourrr · 2026-09-18T02:33:23Z

页面定位不同：DuckDB install 是单目标任务页——用户只要"给我当前平台+语言的一条安装命令"，二维选择器是最优解。而 Platform Support 是兼容性参考页，要同时回答三类全局问题：有哪些 SDK 及安装方式、CI 验证了哪些 OS/架构组合且有预编译产物、每类索引在哪些平台可用。
后两类天然是跨平台对比信息，选择器一次只显示一个组合，反而更难用。

表格是矩阵信息的标准载体，不是"乱"：索引可用性是索引×7平台的 8×7 矩阵，CI 验证是平台×架构×验证方式×产物的关系，多对多关系在静态文档里只有表格能一眼扫全。

DuckDB 风格提供的信息本页已有：SDK 表的 Install 列就是安装命令（pip install zvec、npm install @zvec/zvec…），等于选择器的输出；选择器额外只给"过滤"，而本页过滤收益极小（SDK 仅 6 行），代价却是丢掉全局视图。

工程与生态成本：站点文档全是静态 MDX（fumadocs），表格零组件、零维护，且可被搜索引擎、llms.txt、屏幕阅读器、打印和 LLM 直接消费；改交互选择器要写自定义组件并维护一套 per-platform 数据结构，与 benchmarks、quickstart 等全站表格风格割裂。

"乱"可以低成本收敛一下（1ae2c92）：

删掉了 per-SDK 补充说明折叠块和生态工具段落，首屏只留 SDK 表 + 平台表 + 索引矩阵，密度明显下降

索引矩阵索引添加链接，指向其concept页

✅/❌ 增加图例行，避免歧义

可是这种很详细的表格更适合给我们这些内部开发者看，而不适合给外部用户看。外部用户都是有很明确的倾向的，我就是来使用 python sdk 的，或者我就是来使用 rust sdk 的，那我就不关心 nodejs sdk 是否支持 linux/arm64。给他们一个这种表格感觉会造成比较重的心智负担。可以做成像duckdb 那样，让用户自己选择sdk，然后会跳出该sdk相关的安装指令和适配的平台。

索引可用性用表格来表达倒是比较合适的

External users usually arrive with a language in mind, so replace the wide SDK comparison table with fumadocs Tabs: each tab shows only the install command, prebuilt platform coverage, and repository link for that SDK, matching the DuckDB installer experience while staying static MDX.

External readers care about whether prebuilt artifacts exist for their OS/arch; the CI details were internal-oriented density. The legend row still explains the check/cross marks, including RISC-V build-from-source.

chinaux · 2026-09-18T03:01:46Z

同步最新改动（c682127）：「支持的软硬件平台」表去掉了 CI 验证列，只保留平台 / 架构 / 预编译产物三列；✅/❌ 的含义由表下图例行说明（含 RISC-V 需源码构建）。SDK Tabs 与索引矩阵不变。

新预览：

zhourrr · 2026-09-20T03:22:36Z

+```
+
+- **预编译覆盖**：Linux x64 / ARM64、macOS ARM64、Windows x64
+- **代码仓库**：[zvec-ai/zvec-go](https://github.com/zvec-ai/zvec-go)


当前显示效果有点奇怪，这里感觉直接放原始链接就可以了，直接 https://github.com/zvec-ai/zvec-go

zhourrr · 2026-09-20T03:23:45Z

+npm install @zvec/zvec
+```
+
+- **预编译覆盖**：Linux x86_64 / ARM64（glibc 与 musl）、macOS ARM64 / x64、Windows x64


预编译覆盖改成 bullet point 试试
预编译覆盖：

linux

mac

windows

zhourrr · 2026-09-20T03:24:49Z

+| iOS | arm64 | ✅ |
+| RISC-V | riscv64 | ❌ |
+
+*✅ = 提供预编译产物 · ❌ = 需源码构建。*


这句话感觉有点多余，直接这样？ | RISC-V | riscv64 | ❌ (需源码构建) |

zhourrr · 2026-09-20T03:25:16Z

+| [INVERT](../concepts/inverted-index/)（标量倒排） | ✅ | ✅ | ✅ | ✅ | ✅ | ✅ | ✅ |
+| [FTS](../concepts/fts-index/)（全文检索） | ✅ | ✅ | ✅ | ✅ | ✅ | ✅ | ✅ |
+
+*✅ = 该平台可用 · ❌ = 不支持。*


有点多余

feihongxu0824 · 2026-09-21T02:36:26Z

+
+All SDKs share one stable C API boundary — pick your language to see the install command and prebuilt platform coverage.
+
+<Tabs items={['Python', 'Node.js', 'Go', 'Rust', 'Java', 'Dart / Flutter']}>


C/C++的也要加上

feihongxu0824 · 2026-09-21T02:39:50Z

+
+*✅ = prebuilt artifacts published · ❌ = build from source.*
+
+## Index Availability


这部分可以默认折叠，默认只给用户最简单的信息：支持什么语言、平台、安装方式

feihongxu0824 · 2026-09-21T02:41:31Z

+</Tabs>
+
+
+## Supported Platforms


语言/安装方式/支持平台，这几部分可以合并一下吧，尽量让用户看起来一眼看完

建议保持分开，见最上面钦仁的讨论，之前是合到一起的，页面看着比较乱

feihongxu0824 · 2026-09-21T02:45:12Z

+| iOS | arm64 | ✅ |
+| RISC-V | riscv64 | ❌ |
+
+*✅ = prebuilt artifacts published · ❌ = build from source.*


“✅ = prebuilt artifacts published · ❌ = build from source.” 这句话可以删掉吧

feihongxu0824 · 2026-09-21T02:48:01Z

+
+## Index Availability
+
+| Index | Linux x86_64 | Linux ARM64 | macOS ARM64 | Windows x86_64 | Android arm64 | iOS arm64 | RISC-V |


“Android arm64” -> "Android arm64-v8a"

- per-SDK prebuilt coverage as bullet points per platform - repository entries shown as raw URLs - add C / C++ tab with prebuilt SDK archive install example - drop the ✅/❌ legend sentences; RISC-V row carries an inline build-from-source note instead - rename Android arm64 to arm64-v8a in the index matrix - collapse the index availability matrix behind an accordion so the default view stays language + install + platforms

chinaux added 2 commits September 18, 2026 10:43

docs: drop CI verification column from supported platforms table

c682127

External readers care about whether prebuilt artifacts exist for their OS/arch; the CI details were internal-oriented density. The legend row still explains the check/cross marks, including RISC-V build-from-source.

zhourrr reviewed Sep 20, 2026

View reviewed changes

feihongxu0824 requested changes Sep 21, 2026

View reviewed changes

feihongxu0824 reviewed Sep 21, 2026

View reviewed changes


		All SDKs share one stable C API boundary — pick your language to see the install command and prebuilt platform coverage.

		<Tabs items={['Python', 'Node.js', 'Go', 'Rust', 'Java', 'Dart / Flutter']}>


		✅ = prebuilt artifacts published · ❌ = build from source.

		## Index Availability


		## Index Availability

		\| Index \| Linux x86_64 \| Linux ARM64 \| macOS ARM64 \| Windows x86_64 \| Android arm64 \| iOS arm64 \| RISC-V \|

Conversation

chinaux commented Sep 15, 2026

Uh oh!

github-actions Bot commented Sep 15, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

zhourrr commented Sep 17, 2026

Uh oh!

chinaux commented Sep 18, 2026

Uh oh!

zhourrr commented Sep 18, 2026

Uh oh!

chinaux commented Sep 18, 2026

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

This branch has not been deployed

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

3 participants

github-actions Bot commented Sep 15, 2026 •

edited

Loading