diff --git a/README.md b/README.md index a081a11..95f2cd9 100644 --- a/README.md +++ b/README.md @@ -13,7 +13,7 @@ [![PyPI version](https://img.shields.io/pypi/v/lance-csr?color=555)](https://pypi.org/project/lance-csr/) [![License: Apache 2.0](https://img.shields.io/badge/license-Apache%202.0-555)](LICENSE) -[Documentation](https://lance-csr.pages.dev/) · [Examples](examples/README.md) · +[Documentation](https://lance-csr.hdclabs.ai/) · [Examples](examples/README.md) · [Releases](https://github.com/hyperdimensionalcomputingai/lance-csr/releases) · [Contributing](CONTRIBUTING.md) lance-csr is a fast graph query engine over [Lance](https://lancedb.github.io/lance/) datasets, built in Rust on @@ -21,7 +21,7 @@ Apache DataFusion, with Python bindings. It is a fork of [lance-graph](https://g and a research test bed: it pushes the limits of CSR indexes and DataFusion on top of the Lance format, with the goal of making multi-hop path traversal fast. -**Documentation:** Visit the [lance-csr documentation site](https://lance-csr.pages.dev/) for getting started, +**Documentation:** Visit the [lance-csr documentation site](https://lance-csr.hdclabs.ai/) for getting started, Cypher guides, the CSR index, the Python API reference, and benchmarks. ## Goals @@ -93,7 +93,7 @@ See [`python/README.md`](python/README.md) for details and usage. To use the engine from Rust, add the crate with `cargo add lance-csr` and see [`crates/lance-csr/README.md`](crates/lance-csr/README.md) and the -[Rust guide](https://lance-csr.pages.dev/rust/). +[Rust guide](https://lance-csr.hdclabs.ai/rust/). ## Build from source diff --git a/crates/lance-csr-catalog/Cargo.toml b/crates/lance-csr-catalog/Cargo.toml index 4de57e7..7598d04 100644 --- a/crates/lance-csr-catalog/Cargo.toml +++ b/crates/lance-csr-catalog/Cargo.toml @@ -5,6 +5,7 @@ edition = "2021" license = "Apache-2.0" authors = ["The lance-csr Authors"] repository = "https://github.com/hyperdimensionalcomputingai/lance-csr" +homepage = "https://lance-csr.hdclabs.ai/" readme = "README.md" description = "Catalog and namespace utilities for Lance graph" keywords = ["lance", "graph", "catalog", "namespace"] diff --git a/crates/lance-csr/Cargo.toml b/crates/lance-csr/Cargo.toml index 71308d2..cfdbc70 100644 --- a/crates/lance-csr/Cargo.toml +++ b/crates/lance-csr/Cargo.toml @@ -5,6 +5,7 @@ edition = "2021" license = "Apache-2.0" authors = ["The lance-csr Authors"] repository = "https://github.com/hyperdimensionalcomputingai/lance-csr" +homepage = "https://lance-csr.hdclabs.ai/" readme = "README.md" description = "Graph query engine for Lance datasets with Cypher support" keywords = ["lance", "graph", "cypher", "query", "datafusion"] diff --git a/crates/lance-csr/README.md b/crates/lance-csr/README.md index 2df4bbb..740d789 100644 --- a/crates/lance-csr/README.md +++ b/crates/lance-csr/README.md @@ -44,8 +44,8 @@ new write with `refresh()`: cargo run -p lance-csr --example embedded_query ``` -The [Rust guide](https://lance-csr.pages.dev/rust/) covers the API, and the rest of the -[documentation](https://lance-csr.pages.dev/) covers the graph schema, supported Cypher and the CSR index. +The [Rust guide](https://lance-csr.hdclabs.ai/rust/) covers the API, and the rest of the +[documentation](https://lance-csr.hdclabs.ai/) covers the graph schema, supported Cypher and the CSR index. Building the crate needs `protoc` for Lance's dependencies. For one query over in-memory batches, `CypherQuery` works without an engine: @@ -141,7 +141,7 @@ A builder (`CypherQueryBuilder`) is also available for constructing queries prog ## Supported Cypher -See [Supported Cypher](https://lance-csr.pages.dev/cypher/#supported-cypher) in the documentation for the +See [Supported Cypher](https://lance-csr.hdclabs.ai/cypher/#supported-cypher) in the documentation for the clauses, patterns, expressions and functions the engine runs. ## Crate Layout @@ -204,7 +204,7 @@ cargo test -p lance-csr ## Benchmarks All published numbers were measured through the Python package; see the -[benchmarks page](https://lance-csr.pages.dev/benchmarks/). Criterion micro-benchmarks live in the unpublished +[benchmarks page](https://lance-csr.hdclabs.ai/benchmarks/). Criterion micro-benchmarks live in the unpublished `lance-csr-benches` crate. ## Python Bindings diff --git a/docs/AGENTS.md b/docs/AGENTS.md index 584da48..11965e9 100644 --- a/docs/AGENTS.md +++ b/docs/AGENTS.md @@ -18,8 +18,9 @@ the internals; `rust.md` covers the same engine for Rust developers. The CSR ind - Preview with `uv run --project docs --locked zensical serve`; check with `uv run --project docs --locked zensical build --strict`, which CI runs on every pull request. Fix every warning. -- Cloudflare Pages builds and hosts the site at https://lance-csr.pages.dev/ through its native GitHub - integration. Pushes to `main` automatically deploy when automatic production deployments are enabled. +- Cloudflare Pages builds and hosts the site at https://lance-csr.hdclabs.ai/ (a custom domain on the + `lance-csr` Pages project) through its native GitHub integration. `site_url` in `zensical.toml` must match + it, because it sets the canonical and social-preview URLs. Pushes to `main` automatically deploy when automatic production deployments are enabled. Build from the repository root with the locked build command above and publish `site/`. - Files that aren't pages (this file, `check_snippets.py`, `sync_benchmarks.py`, the uv project, `overrides/`, the brand README and previews) are listed under `exclude_docs` in `zensical.toml`. Add new non-page files there. diff --git a/python/pyproject.toml b/python/pyproject.toml index 0d859c7..55670b2 100644 --- a/python/pyproject.toml +++ b/python/pyproject.toml @@ -28,6 +28,12 @@ classifiers = [ "Topic :: Scientific/Engineering", ] +[project.urls] +Documentation = "https://lance-csr.hdclabs.ai/" +Repository = "https://github.com/hyperdimensionalcomputingai/lance-csr" +Issues = "https://github.com/hyperdimensionalcomputingai/lance-csr/issues" +Releases = "https://github.com/hyperdimensionalcomputingai/lance-csr/releases" + [tool.maturin] python-source = "python" module-name = "lance_csr._internal" diff --git a/zensical.toml b/zensical.toml index 5cc7961..7589b71 100644 --- a/zensical.toml +++ b/zensical.toml @@ -1,6 +1,6 @@ [project] site_name = "lance-csr" -site_url = "https://lance-csr.pages.dev/" +site_url = "https://lance-csr.hdclabs.ai/" site_description = "A fast, embedded Cypher graph query engine over Lance datasets, with a CSR adjacency index" site_author = "The lance-csr Authors" copyright = "Copyright © The lance-csr Authors. Apache 2.0 licensed."