diff --git a/.github/workflows/check.yml b/.github/workflows/check.yml index f57f302..dc1edf3 100644 --- a/.github/workflows/check.yml +++ b/.github/workflows/check.yml @@ -27,4 +27,4 @@ jobs: fail: true format: markdown jobSummary: true - lycheeVersion: v0.20.1 + lycheeVersion: v0.22.0 diff --git a/.vitepress/config.mts b/.vitepress/config.mts index 3607f94..cf23a48 100644 --- a/.vitepress/config.mts +++ b/.vitepress/config.mts @@ -21,7 +21,15 @@ export default defineConfig({ }, // pgvecto_rs doc should have a route of / to keep back compatible rewrites: { - 'pgvecto_rs/:dir/:page*': ':dir/:page*', + 'pgvecto_rs/admin/:page*': 'admin/:page*', + 'pgvecto_rs/community/:page*': 'community/:page*', + 'pgvecto_rs/developers/:page*': 'developers/:page*', + 'pgvecto_rs/faqs/:page*': 'faqs/:page*', + 'pgvecto_rs/getting-started/:page*': 'getting-started/:page*', + 'pgvecto_rs/integration/:page*': 'integration/:page*', + 'pgvecto_rs/reference/:page*': 'reference/:page*', + 'pgvecto_rs/usage/:page*': 'usage/:page*', + 'pgvecto_rs/use-case/:page*': 'use-case/:page*', 'vectorchord/usage/multi-vector-retrieval.md': 'vectorchord/usage/indexing-with-maxsim-operators.md', 'vectorchord/usage/similarity-filter.md': 'vectorchord/usage/range-query.md', 'vectorchord/usage/postgresql-tuning.md': 'vectorchord/usage/performance-tuning.md', diff --git a/lychee.toml b/lychee.toml index e34545f..09bb07c 100644 --- a/lychee.toml +++ b/lychee.toml @@ -7,12 +7,22 @@ accept = [ 429, # Terraform 999, # LinkedIn ] +root_dir = "src" remap = [ "(https://github.com/[^/]+/[^/]+/blob/[^#]+)#[a-zA-Z0-9._-]* $1", # remove fragment from GitHub **blob** URLS "(https://github.com/[^/]+/[^/]+/tree/[^#]+)#[a-zA-Z0-9._-]* $1", # remove fragment from GitHub **main** URLS # `rewrites` from the `.vitepress/config.mts` file - "([\\w]+)/vectorchord/usage/indexing-with-maxsim-operators $1/vectorchord/usage/multi-vector-retrieval", - "([\\w]+)/vectorchord/usage/range-query $1/vectorchord/usage/similarity-filter", - "([\\w]+)/vectorchord/usage/performance-tuning $1/vectorchord/usage/postgresql-tuning", - "([\\w]+)/vectorchord/usage/external-index-precomputation $1/vectorchord/usage/external-build", + "([\\w]+)/src/admin/(.*) $1/src/pgvecto_rs/admin/$2", + "([\\w]+)/src/community/(.*) $1/src/pgvecto_rs/community/$2", + "([\\w]+)/src/developers/(.*) $1/src/pgvecto_rs/developers/$2", + "([\\w]+)/src/faqs/(.*) $1/src/pgvecto_rs/faqs/$2", + "([\\w]+)/src/getting-started/(.*) $1/src/pgvecto_rs/getting-started/$2", + "([\\w]+)/src/integration/(.*) $1/src/pgvecto_rs/integration/$2", + "([\\w]+)/src/reference/(.*) $1/src/pgvecto_rs/reference/$2", + "([\\w]+)/src/usage/(.*) $1/src/pgvecto_rs/usage/$2", + "([\\w]+)/src/use-case/(.*) $1/src/pgvecto_rs/use-case/$2", + "([\\w]+)/src/vectorchord/usage/indexing-with-maxsim-operators $1/src/vectorchord/usage/multi-vector-retrieval", + "([\\w]+)/src/vectorchord/usage/range-query $1/src/vectorchord/usage/similarity-filter", + "([\\w]+)/src/vectorchord/usage/performance-tuning $1/src/vectorchord/usage/postgresql-tuning", + "([\\w]+)/src/vectorchord/usage/external-index-precomputation $1/src/vectorchord/usage/external-build", ] diff --git a/src/vectorchord/usage/graph-index.md b/src/vectorchord/usage/graph-index.md index aa7be93..a0e47e4 100644 --- a/src/vectorchord/usage/graph-index.md +++ b/src/vectorchord/usage/graph-index.md @@ -146,8 +146,9 @@ All operator classes are available since version `0.3.0`. - Description: The GUC parameter `vchordg.max_scan_tuples` controls the maximum number of tuples that can be scanned in a vector search. In most cases, you do not need to set this parameter, because the `LIMIT` clause serves a similar purpose. However, when a `WHERE` clause is present, the `LIMIT` clause applies after filtering, while this GUC parameter applies before filtering. This parameter is intended to prevent performance degradation when the filtering selectivity is very low. - Type: integer +- Default: `-1` - Domain: `[-1, 2147483647]` - Example: - - `SET vchordg.max_scan_tuples = 999` indicates the index scans returns at most $999$ tuples. - - `SET vchordg.max_scan_tuples = -1` indicates the required number of tuples. + - `SET vchordg.max_scan_tuples = 999` indicates the index scan returns at most $999$ tuples. + - `SET vchordg.max_scan_tuples = -1` indicates no limit on the number of tuples. - Note: This parameter has no effect when set to `-1`. diff --git a/src/vectorchord/usage/indexing.md b/src/vectorchord/usage/indexing.md index 89e6259..82ba639 100644 --- a/src/vectorchord/usage/indexing.md +++ b/src/vectorchord/usage/indexing.md @@ -303,8 +303,9 @@ This is the default value of index building. The index will not be partitioned. - Description: The GUC parameter `vchordrq.max_scan_tuples` controls the maximum number of tuples that can be scanned in a vector search. In most cases, you do not need to set this parameter, because the `LIMIT` clause serves a similar purpose. However, when a `WHERE` clause is present, the `LIMIT` clause applies after filtering, while this GUC parameter applies before filtering. This parameter is intended to prevent performance degradation when the filtering selectivity is very low. - Type: integer +- Default: `-1` - Domain: `[-1, 2147483647]` - Example: - - `SET vchordrq.max_scan_tuples = 999` indicates the index scans returns at most $999$ tuples. - - `SET vchordrq.max_scan_tuples = -1` indicates the required number of tuples. + - `SET vchordrq.max_scan_tuples = 999` indicates the index scan returns at most $999$ tuples. + - `SET vchordrq.max_scan_tuples = -1` indicates no limit on the number of tuples. - Note: This parameter has no effect when set to `-1`.