sync docs with README.md #106
Conversation
|
The latest updates on your projects. Learn more about Vercel for Git ↗︎
|
There was a problem hiding this comment.
Pull Request Overview
This PR syncs the documentation with the latest README.md content by updating the overview, installation instructions, and adding new sections on performance tuning, index build options, and advanced features.
- Updated the overview with revised feature descriptions, new sections (e.g., Long Vector Support, Capacity-optimized Index), and updated SQL snippets.
- Updated the Docker image version and installation instructions with clearer descriptions.
Reviewed Changes
Copilot reviewed 2 out of 2 changed files in this pull request and generated 2 comments.
| File | Description |
|---|---|
| src/vectorchord/getting-started/overview.md | Updated overview text, feature sections, SQL examples and index options. |
| src/vectorchord/getting-started/installation.md | Clarified installation instructions for Debian packages and binaries. |
Comments suppressed due to low confidence (3)
src/vectorchord/getting-started/overview.md:25
- [nitpick] Consider rewording the phrase to 'consider changing [VECTOR_MAX_DIM] and compiling pgvector yourself' for improved clarity.
If you really have a large dimension(`16,000<dim<60,000`), consider to change [VECTOR_MAX_DIM](https://github.com/pgvector/pgvector/blob/fef635c9e5512597621e5669dce845c744170822/src/vector.h#L4) and compile pgvector yourself.
src/vectorchord/getting-started/overview.md:128
- Verify that lowering the 'lists' value from 4096 to 1000 is intentional, as this change might affect index performance for larger datasets.
lists = [1000]
src/vectorchord/getting-started/overview.md:209
- [nitpick] Consider rewording this comment to 'if you need a less precise query, setting it to 1.0 might be appropriate' for improved clarity.
-- If you need a less precise query, set it to 1.0 might be appropriate.
|
There was a problem hiding this comment.
Pull Request Overview
This PR syncs the documentation with the README.md by updating various sections, improving clarity and consistency for new users. Key changes include rewording of feature descriptions and installation instructions, updated version references, and a reorganization of the documentation sections.
Reviewed Changes
Copilot reviewed 2 out of 2 changed files in this pull request and generated 1 comment.
| File | Description |
|---|---|
| src/vectorchord/getting-started/overview.md | Updated overview content, added new sections on performance tuning, advanced features, and dual license details |
| src/vectorchord/getting-started/installation.md | Clarified language regarding installation methods and platform support |
There was a problem hiding this comment.
Pull Request Overview
This PR updates the documentation to synchronize the content with the latest README.md. It refines sections in the Overview and Installation guides, adds new details on performance tuning, and clarifies licensing and index creation options.
Reviewed Changes
Copilot reviewed 2 out of 2 changed files in this pull request and generated 1 comment.
| File | Description |
|---|---|
| src/vectorchord/getting-started/overview.md | Restructured content, added new sections on performance tuning and index builds, and updated licensing details. |
| src/vectorchord/getting-started/installation.md | Revised installation instructions for clarity on supported Linux architectures. |
Comments suppressed due to low confidence (1)
src/vectorchord/getting-started/overview.md:11
- The footnote reference for index building performance changed from [^3] to [^1]. Please verify that footnotes are consistently numbered and referenced throughout the document.
**⚡ Enhanced Performance**: Delivering optimized operations with up to 5x faster queries, 16x higher insert throughput, and 16x quicker[^1] index building compared to pgvector's HNSW implementation.
There was a problem hiding this comment.
Pull Request Overview
This PR synchronizes the documentation with the README.md by updating and adding content across several usage and getting-started files to ensure consistency in messaging and instructions.
- Introduces a new "Performance Tuning" document with detailed SQL tuning parameters.
- Updates the "Indexing," "Advanced Features," and "Getting Started" sections to reflect current best practices.
- Revises the sidebar configuration in VitePress to include new documentation entries.
Reviewed Changes
Copilot reviewed 6 out of 6 changed files in this pull request and generated 2 comments.
Show a summary per file
| File | Description |
|---|---|
| src/vectorchord/usage/performance-tuning.md | New document on tuning performance with SQL examples. |
| src/vectorchord/usage/indexing.md | Updated instructions and SQL examples for indexing. |
| src/vectorchord/usage/advanced-features.md | Added advanced usage features and external precomputation steps. |
| src/vectorchord/getting-started/overview.md | Updated overview and quick start instructions. |
| src/vectorchord/getting-started/installation.md | Clarified installation instructions for Debian and prebuilt packages. |
| .vitepress/config.mts | Updated navigation to reflect new documentation sections. |
There was a problem hiding this comment.
Pull Request Overview
This PR syncs the documentation with the README.md by updating existing pages and adding new sections. The changes include the addition of performance tuning and advanced features guides, revisions to indexing and overview content, and updates to navigation links.
Reviewed Changes
Copilot reviewed 6 out of 6 changed files in this pull request and generated 1 comment.
Show a summary per file
| File | Description |
|---|---|
| src/vectorchord/usage/performance-tuning.md | New documentation detailing performance tuning options and benchmarks. |
| src/vectorchord/usage/indexing.md | Modified instructions and examples for index creation and query performance. |
| src/vectorchord/usage/advanced-features.md | New documentation covering advanced features including index prewarm and external indexing. |
| src/vectorchord/getting-started/overview.md | Updated overview with revised product features, commands, and licensing information. |
| src/vectorchord/getting-started/installation.md | Minor wording adjustments in installation instructions. |
| .vitepress/config.mts | Added navigation links for the new Performance Tuning and Advanced Features documentation. |
Comments suppressed due to low confidence (1)
src/vectorchord/getting-started/overview.md:75
- This configuration statement appears problematic since setting probes to an empty string may be invalid. Consider using a valid numeric value or removing the statement if not needed.
SET vchordrq.probes TO '';
There was a problem hiding this comment.
Pull Request Overview
This PR syncs the documentation with the README.md and makes several updates to various markdown files covering performance tuning, indexing, advanced features, installation, and quick start guides. Key changes include the addition of new pages for performance tuning and advanced features, updates and corrections to existing indexing and overview documentation, and navigation enhancements in the docs configuration.
Reviewed Changes
Copilot reviewed 6 out of 6 changed files in this pull request and generated 1 comment.
Show a summary per file
| File | Description |
|---|---|
| src/vectorchord/usage/performance-tuning.md | New documentation page detailing performance tuning settings. |
| src/vectorchord/usage/indexing.md | Updated examples and notes for index creation and usage. |
| src/vectorchord/usage/advanced-features.md | New markdown file covering advanced features and external index precomputation. |
| src/vectorchord/getting-started/overview.md | Updated overview content, index examples, and quick start instructions. |
| src/vectorchord/getting-started/installation.md | Minor text clarifications regarding installation support. |
| .vitepress/config.mts | Added new navigation links for related documentation pages. |
There was a problem hiding this comment.
Pull Request Overview
This PR synchronizes documentation with README.md by adding new sections and updating existing pages to clarify and streamline usage instructions. Key changes include:
- Addition of new documentation pages for Performance Tuning and Advanced Features.
- Updates to the Indexing and Getting Started pages, including updated SQL examples and Docker image tags.
- Modifications to the site navigation configuration to include the new sections.
Reviewed Changes
Copilot reviewed 6 out of 6 changed files in this pull request and generated no comments.
Show a summary per file
| File | Description |
|---|---|
| src/vectorchord/usage/performance-tuning.md | New page describing performance and index build tuning options. |
| src/vectorchord/usage/indexing.md | Updates to SQL examples and documentation for vector indexing. |
| src/vectorchord/usage/advanced-features.md | New page outlining advanced features and external precomputation. |
| src/vectorchord/getting-started/overview.md | Revised overview with updated examples and installation details. |
| src/vectorchord/getting-started/installation.md | Minor wording clarifications for installation instructions. |
| .vitepress/config.mts | Navigation updates to include new documentation pages. |
Comments suppressed due to low confidence (2)
src/vectorchord/getting-started/overview.md:75
- Setting the 'vchordrq.probes' parameter to an empty string may lead to configuration errors. Please specify a valid numeric value instead.
SET vchordrq.probes TO '';
src/vectorchord/getting-started/overview.md:68
- Using an empty array for 'lists' in the index creation SQL may be problematic if a numeric value is required. Consider verifying and updating this configuration.
lists = []
Signed-off-by: usamoi <usamoi@outlook.com>
There was a problem hiding this comment.
Pull Request Overview
This pull request synchronizes the documentation with the README.md, updating various usage and getting-started guides to reflect the latest changes for VectorChord. Key changes include updates to performance tuning, indexing, advanced features, and installation instructions, as well as adjustments to the sidebar configuration.
Reviewed Changes
Copilot reviewed 6 out of 6 changed files in this pull request and generated 1 comment.
Show a summary per file
| File | Description |
|---|---|
| src/vectorchord/usage/performance-tuning.md | New documentation for performance tuning and index build time details. |
| src/vectorchord/usage/indexing.md | Revised content on index creation for L2, inner product, and cosine distances. |
| src/vectorchord/usage/advanced-features.md | Added advanced features documentation including prewarm and capacity-optimized index. |
| src/vectorchord/getting-started/overview.md | Updated overview content, Docker image version, and quick-start instructions. |
| src/vectorchord/getting-started/installation.md | Adjusted installation instructions with clarified platform details. |
| .vitepress/config.mts | Updated sidebar configuration to reflect new documentation sections. |
pull request in docs repo: tensorchord/pgvecto.rs-docs#106 [Rendered README.md](https://github.com/usamoi/VectorChord/blob/readme/README.md) [Preview docs](https://pgvecto-rs-docs-83ki0aiml-tensorchord.vercel.app/vectorchord/getting-started/overview.html) Signed-off-by: usamoi <usamoi@outlook.com>
No description provided.