Skip to content

Commit 5bd3b0a

Browse files
committed
docs: point published URL to docs.redisvl.com/projects/sql-redis/
1 parent 2cba98f commit 5bd3b0a

4 files changed

Lines changed: 11 additions & 9 deletions

File tree

AGENTS.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -106,8 +106,8 @@ Full reference, generated from docstrings, is at `docs/api/`.
106106

107107
sql-redis sits in the [Redis AI Hub](https://redis.io/ai-hub/) under the
108108
*Experimental* tier as "SQL for Redis". Public docs URL:
109-
[`ai.redis.io/sql/`](https://ai.redis.io/sql/). The hub's docs standards
110-
(Diataxis layout, autoclass-driven API reference, AI-agent affordances) are
111-
documented at
109+
[`docs.redisvl.com/projects/sql-redis/`](https://docs.redisvl.com/projects/sql-redis/).
110+
The hub's docs standards (Diataxis layout, autoclass-driven API reference,
111+
AI-agent affordances) are documented at
112112
[`HUB_DOCS_STANDARDS.md`](https://github.com/redis/docs/blob/main/HUB_DOCS_STANDARDS.md)
113113
in the hub repo.

README.md

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -35,13 +35,13 @@ for row in result.rows:
3535

3636
## Documentation
3737

38-
Full documentation, including a Diátaxis-aligned guide, concept docs, and API reference, lives in [`docs/`](docs/) and is published via Read the Docs.
38+
Full documentation is published at **[docs.redisvl.com/projects/sql-redis/](https://docs.redisvl.com/projects/sql-redis/)**.
3939

40-
- **Getting started:** [`docs/user_guide/getting-started.md`](docs/user_guide/getting-started.md)
41-
- **How-to guides:** [`docs/user_guide/how_to_guides/`](docs/user_guide/how_to_guides/)
42-
- **Concepts and design:** [`docs/concepts/`](docs/concepts/)
43-
- **API reference:** [`docs/api/`](docs/api/)
44-
- **SQL syntax catalog:** [`docs/api/sql-syntax.md`](docs/api/sql-syntax.md)
40+
- **Getting started:** [User Guide](https://docs.redisvl.com/projects/sql-redis/en/latest/user_guide/getting-started.html)
41+
- **How-to guides:** [How-to Guides](https://docs.redisvl.com/projects/sql-redis/en/latest/user_guide/how_to_guides/)
42+
- **Concepts and design:** [Concepts](https://docs.redisvl.com/projects/sql-redis/en/latest/concepts/)
43+
- **API reference:** [API](https://docs.redisvl.com/projects/sql-redis/en/latest/api/)
44+
- **SQL syntax catalog:** [SQL Syntax](https://docs.redisvl.com/projects/sql-redis/en/latest/api/sql-syntax.html)
4545

4646
## For AI agents
4747

docs/conf.py

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -63,4 +63,5 @@
6363
intersphinx_mapping = {
6464
"python": ("https://docs.python.org/3", None),
6565
"redis": ("https://redis-py.readthedocs.io/en/stable/", None),
66+
"redisvl": ("https://docs.redisvl.com/", None),
6667
}

pyproject.toml

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -29,6 +29,7 @@ dependencies = [
2929
[project.urls]
3030
Homepage = "https://github.com/redis-developer/sql-redis"
3131
Repository = "https://github.com/redis-developer/sql-redis"
32+
Documentation = "https://docs.redisvl.com/projects/sql-redis/"
3233

3334
[build-system]
3435
requires = ["hatchling"]

0 commit comments

Comments
 (0)