docs: add VSAG 1.0 release notes#2453
Conversation
wxyucs
added
kind/documentation
|
/label S-waiting-on-review |
Merge Protections🟢 All 2 merge protections satisfied — ready to merge. Show 2 satisfied protections🟢 Require kind label
🟢 Require version label
|
![gemini-code-assist[bot]](https://avatars.githubusercontent.com/in/956858?s=60&v=4){kind=small}
There was a problem hiding this comment.
Code Review
This pull request introduces comprehensive documentation for the VSAG 1.0 release, including detailed release notes, compatibility and upgrade guidance, and updates to the project roadmap. The changes restructure the release notes to group versions by series, provide specific details for the v1.0.0 release, and clarify upgrade paths. My review suggests improving the consistency of Chinese technical terminology by translating terms like 'analyze' and 'streaming' to their Chinese equivalents for better readability.
Important
The consumer version of Gemini Code Assist on GitHub is being sunset. Starting June 18, 2026, new organization installations will be blocked, and all code review activity will officially cease on July 17, 2026.
For more details on the timeline and next steps, please review the Help Documentation.
| analyze、immutable read、稀疏 FP16 值、紧凑存储，以及 | ||
| [低内存 immutable build](https://github.com/antgroup/vsag/pull/2424)。 |
There was a problem hiding this comment.
For better readability and professional consistency in the Chinese documentation, consider translating the English technical terms analyze, immutable read, and immutable build into their Chinese equivalents, while keeping the original English terms in parentheses if necessary.
| analyze、immutable read、稀疏 FP16 值、紧凑存储，以及 | |
| [低内存 immutable build](https://github.com/antgroup/vsag/pull/2424)。 | |
| 分析支持（analyze）、不可变读取（immutable read）、稀疏 FP16 值、紧凑存储，以及 | |
| [低内存不可变构建（immutable build）](https://github.com/antgroup/vsag/pull/2424)。 |
| - `DeserializeStreaming` 将数据恢复到已创建、为空且兼容的索引对象； | ||
| - `Index::Load` 读取 metadata、创建对应索引并应用支持的存储放置策略； | ||
| - BruteForce、HGraph、IVF、mutable SINDI、Pyramid | ||
| 已实现 v1.0 streaming 路径。 |
There was a problem hiding this comment.
To maintain terminology consistency with the term '流式序列化格式' (streaming serialization format) introduced on line 107, consider translating 'streaming 路径' to '流式序列化路径' (or '流式路径') instead of leaving 'streaming' in English. Similarly, consider translating other occurrences of 'streaming' (e.g., 'streaming 可视化' on line 140 and 'streaming 输出' on line 178) to '流式' or '流式序列化' for consistency.
| 已实现 v1.0 streaming 路径。 | |
| 已实现 v1.0 流式序列化路径。 |
Signed-off-by: Xiangyu Wang <wxy407827@antgroup.com> Assisted-by: Codex:gpt-5
08770d3 to
e7fa013
Compare
|
Automated pull request review completed. Review effort: No actionable inline findings were found. |
Signed-off-by: Xiangyu Wang <wxy407827@antgroup.com> Assisted-by: Codex:gpt-5
Signed-off-by: Xiangyu Wang <wxy407827@antgroup.com> Assisted-by: Codex:gpt-5
Signed-off-by: Xiangyu Wang <wxy407827@antgroup.com> Assisted-by: Codex:gpt-5
Signed-off-by: Xiangyu Wang <wxy407827@antgroup.com> Assisted-by: Codex:gpt-5
vsag-bot
left a comment
vsag-bot
left a comment
There was a problem hiding this comment.
Automated inline review completed.
Review effort: high (833 changed lines across 10 files).
Submitted 2 inline comments.
Reviewed commit 886e3b3.
|
|
||
| ```bash | ||
| pip install pyvsag==X.Y.Z | ||
| pip install pyvsag |
There was a problem hiding this comment.
[P2] Pin the requested Python version
This command appears under “Getting a Specific Version,” but it always asks pip for the newest compatible pyvsag release. As soon as multiple wheels are available, following this section can install a different binding version than intended; use an explicit published-version placeholder such as pyvsag==X.Y.Z after the PyPI availability warning.
| ## Overview | ||
|
|
||
| VSAG 1.0 is the project's first long-term-support major release. The public `0.x` history spans | ||
| 81 tags across the `v0.11`-`v0.18` maintenance lines. The `v1.0.0` tag captures the final |
There was a problem hiding this comment.
[P3] Correct the v0.x tag count
The repository contains 82 tags across v0.11-v0.18 (15 + 1 + 6 + 10 + 13 + 23 + 4 + 10), not 81. Correct this total and the mirrored Chinese statement so the release-history summary matches the cited tag set.
Signed-off-by: Xiangyu Wang <wxy407827@antgroup.com> Assisted-by: Codex:gpt-5
vsag-bot
left a comment
vsag-bot
left a comment
There was a problem hiding this comment.
Automated inline review completed.
Review effort: high (822 changed lines across 10 files).
No actionable inline findings were found.
Reviewed commit da763ae.
Summary
major.minorwebsite structure for release notescommit history
Why
The existing website page only linked to GitHub Releases. This change adds an editorial,
browsable release note while keeping GitHub as the authoritative patch-level history. Future
patches update the relevant
major.minorpage, and future minor or major lines get a new page.Validation
mdbook build docs/docs/en -d /tmp/vsag-mdbook-en-release-notesmdbook build docs/docs/zh -d /tmp/vsag-mdbook-zh-release-notesgit diff --check