JingsongLi opened a new pull request, #61: URL: https://github.com/apache/paimon-vector-index/pull/61
## Summary - add a responsive English HTML documentation site for all five vector-index families - document index selection, algorithms, tuning parameters, capacity estimates, and v1 storage layouts - add unified Rust, C, C++, Java/JNI, and Python API examples plus metadata-filter pushdown guidance - move benchmark and development instructions out of the top-level README into dedicated documentation - reduce the README to a concise project entry point with links to the detailed guides ## Why The README had grown into a long reference manual and repeated details that are easier to navigate and maintain as topic-focused pages. The new documentation separates index selection, API usage, and development workflows while keeping the README concise. ## Impact Users can compare index trade-offs and open a dedicated page for each implementation. Integrators get one cross-language API guide, and contributors get a separate benchmark and verification guide. The site is fully static, supports responsive navigation and light/dark themes, and introduces no runtime dependency. ## Validation - validated balanced HTML tags, page landmarks, unique IDs, and English `lang` metadata across all 8 pages - resolved 172 local links and anchors - verified all documentation content is English - checked JavaScript syntax with `node --check docs/docs.js` - checked CSS structure and responsive English-layout breakpoints - ran ASF license-header validation and whitespace checks -- This is an automated message from the Apache Git Service. To respond to the message, please log on to GitHub and use the URL above to go to the specific comment. To unsubscribe, e-mail: [email protected] For queries about this service, please contact Infrastructure at: [email protected]
