docs: add SIMQ index documentation for en and zh#2441
Conversation
Add dedicated SIMQ index pages to both English and Chinese documentation, covering algorithm overview, quick-start code, build/search parameter tables, and practical guidance for multi-vector (ColBERT / late-interaction) retrieval. Register SIMQ in SUMMARY.md navigation and indexes/README.md overview table. Signed-off-by: SiaSheerland <x1075956441x@163.com>
|
/label S-ready-to-merge |
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 adds comprehensive English and Chinese documentation for the new SIMQ index, which is designed for multi-vector retrieval using MaxSim scoring (e.g., ColBERT). The feedback highlights a configuration hierarchy inaccuracy in both language versions: the parameters dim, dtype, and metric_type are described as living under index_param, whereas they are actually top-level parameters in the VSAG configuration JSON. Clarifying this distinction will prevent configuration errors for users.
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.
There was a problem hiding this comment.
Pull request overview
Adds end-user documentation for the new SIMQ multi-vector index to the VSAG docs site (English + Chinese), and wires it into the navigation and index overview tables.
Changes:
- Added new SIMQ index pages:
indexes/simq.md(en/zh) with algorithm overview, quick-start, and parameter tables. - Registered SIMQ in
SUMMARY.mdnavigation (en/zh). - Added SIMQ to the indexes overview table in
indexes/README.md(en/zh).
Reviewed changes
Copilot reviewed 6 out of 6 changed files in this pull request and generated 6 comments.
Show a summary per file
| File | Description |
|---|---|
| docs/docs/en/src/SUMMARY.md | Adds SIMQ to the English docs navigation. |
| docs/docs/en/src/indexes/simq.md | New English SIMQ documentation page (overview, quick start, params). |
| docs/docs/en/src/indexes/README.md | Adds SIMQ row to the English indexes overview table. |
| docs/docs/zh/src/SUMMARY.md | Adds SIMQ to the Chinese docs navigation. |
| docs/docs/zh/src/indexes/simq.md | New Chinese SIMQ documentation page (overview, quick start, params). |
| docs/docs/zh/src/indexes/README.md | Adds SIMQ row to the Chinese indexes overview table. |
LHT129
added
version/1.1
kind/documentation
Clarify that dim/dtype/metric_type are top-level build fields while SIMQ-specific parameters live under index_param. Correct base_io_type and base_file_path to show their actual defaults from source instead of marking them as required. Signed-off-by: SiaSheerland <x1075956441x@163.com>
Move verbose parameter descriptions out of markdown tables into bullet lists below so that all source lines stay within the 100-character limit required by AGENTS.md. Signed-off-by: SiaSheerland <x1075956441x@163.com>
Signed-off-by: SiaSheerland <x1075956441x@163.com>
|
Tick the box to add this pull request to the merge queue (same as
|
docs: add SIMQ index documentation for en and zh
Change Type
Linked Issue
Closes: #2291
What Changed
docs/docs/en/src/indexes/simq.mdanddocs/docs/zh/src/indexes/simq.md, covering SIMQ algorithm overview, quick-start code, build/search parameter tables, applicable scenarios, and practical guidance for multi-vector (ColBERT / late-interaction) retrieval.SUMMARY.mdnavigation for bothenandzh.indexes/README.mdfor bothenandzh.Test Evidence
make fmtmake lintmake testmake covTest details:
Compatibility Impact
Performance and Concurrency Impact
Documentation Impact
README.mdDEVELOPMENT.mdCONTRIBUTING.mddocs/docs/{en,zh}/src/indexes/simq.md(new),docs/docs/{en,zh}/src/SUMMARY.md,docs/docs/{en,zh}/src/indexes/README.mdRisk and Rollback
751fed0bChecklist
kind/bugandkind/feature; see "Linked Issue" above)[skip ci]prefix)