redis · tylerhutcherson · Jan 10, 2025 · Jan 8, 2025 · Jan 8, 2025 · Jan 8, 2025
diff --git a/.readthedocs.yaml b/.readthedocs.yaml
@@ -0,0 +1,26 @@
+# Read the Docs configuration file
+# See https://docs.readthedocs.io/en/stable/config-file/v2.html for details
+
+# Required
+version: 2
+
+# Set the OS, Python version, and other tools you might need
+build:
+  os: ubuntu-24.04
+  tools:
+    python: "3.11"
+  jobs:
+    post_create_environment:
+      # Install poetry
+      - python -m pip install poetry==1.8.3
+    post_install:
+      # Install dependencies
+      - VIRTUAL_ENV=$READTHEDOCS_VIRTUALENV_PATH poetry install --with docs
+
+# Build documentation in the "docs/" directory with Sphinx
+sphinx:
+   configuration: docs/conf.py
+
+formats:
+  - pdf
+  - epub
diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md
@@ -87,13 +87,13 @@ poetry run serve-docs
 
 ### Getting Redis
 
-In order for your applications to use RedisVL, you must have [Redis](https://redis.io) accessible with Search & Query features enabled on [Redis Cloud](https://redis.com/try-free) or locally in docker with [Redis Stack](https://redis.io/docs/getting-started/install-stack/docker/):
+In order for your applications to use RedisVL, you must have [Redis](https://redis.io) accessible with Search & Query features enabled on [Redis Cloud](https://redis.io/cloud/) or locally in docker with [Redis Stack](https://redis.io/docs/latest/operate/oss_and_stack/install/install-stack/docker/):
 
 ```bash
 docker run -d --name redis-stack -p 6379:6379 -p 8001:8001 redis/redis-stack:latest
 ```
 
-This will also spin up the [FREE RedisInsight GUI](https://redis.com/redis-enterprise/redis-insight/) at `http://localhost:8001`.
+This will also spin up the [FREE RedisInsight GUI](https://redis.io/insight/) at `http://localhost:8001`.
 
 ## How to Report a Bug
 

diff --git a/README.md b/README.md
@@ -62,9 +62,9 @@ Choose from multiple Redis deployment options:
     docker run -d --name redis-stack -p 6379:6379 -p 8001:8001 redis/redis-stack:latest
     ```
 3. [Redis Enterprise](https://redis.io/enterprise/): Commercial, self-hosted database
-4. [Azure Cache for Redis Enterprise](https://learn.microsoft.com/azure/azure-cache-for-redis/quickstart-create-redis-enterprise): Fully managed Redis Enterprise on Azure
+4. [Azure Managed Redis](https://azure.microsoft.com/en-us/products/managed-redis): Fully managed Redis Enterprise on Azure
 
-> Enhance your experience and observability with the free [Redis Insight GUI](https://redis.com/redis-enterprise/redis-insight/).
+> Enhance your experience and observability with the free [Redis Insight GUI](https://redis.io/insight/).
 
 
 # Overview
@@ -371,4 +371,4 @@ For additional help, check out the following resources:
 Please help us by contributing PRs, opening GitHub issues for bugs or new feature ideas, improving documentation, or increasing test coverage. [Read more about how to contribute!](CONTRIBUTING.md)
 
 ## 🚧 Maintenance
-This project is supported by [Redis, Inc](https://redis.com) on a good faith effort basis. To report bugs, request features, or receive assistance, please [file an issue](https://github.com/redis/redis-vl-python/issues).
+This project is supported by [Redis, Inc](https://redis.io) on a good faith effort basis. To report bugs, request features, or receive assistance, please [file an issue](https://github.com/redis/redis-vl-python/issues).
diff --git a/docs/_static/gallery.yaml b/docs/_static/gallery.yaml
@@ -1,16 +1,17 @@
-
 - title: Arxiv Paper Search
-  website: https://docsearch.redisvl.com
-  img-bottom: ../_static/gallery-images/arxiv-search.png
+  website: https://github.com/redis-developer/redis-arxiv-search
+  # img-bottom: ../_static/gallery-images/arxiv-search.png
+- title: eCommerce Search
+  website: https://github.com/redis-developer/redis-product-search
 - title: Real-Time Embeddings with Redis and Bytewax
   website: https://github.com/awmatheson/real-time-embeddings
-  img-bottom: ../_static/gallery-images/bytewax-redis.png
-- title: Question and Answer with OpenAI
-  website: https://www.redisvl.com/docs/html/examples/openai_qna.html
-  img-bottom: ../_static/gallery-images/RedisOpenAI-QnA.png
+  # img-bottom: ../_static/gallery-images/bytewax-redis.png
+- title: Redis RAG Workbench
+  website: https://github.com/redis-developer/redis-rag-workbench
+  # img-bottom: ../_static/gallery-images/RedisOpenAI-QnA.png
 - title: LLM Recommender for Hotels
-  website: https://github.com/RedisVentures/LLM-Recommender
-  img-bottom: ../_static/gallery-images/hotel-recommender.png
-- title: Chat YOUR PDF
-  website: https://github.com/RedisVentures/gcp-redis-llm-stack/tree/main/examples/chat-your-pdf
-  img-bottom: ../_static/gallery-images/chat-your-pdf.png
+  website: https://github.com/redis-applied-ai/LLM-Recommender
+  # img-bottom: ../_static/gallery-images/hotel-recommender.png
+- title: Agentic RAG
+  website: https://github.com/redis-developer/agentic-rag
+  # img-bottom: ../_static/gallery-images/chat-your-pdf.png
diff --git a/docs/_static/js/sidebar.js b/docs/_static/js/sidebar.js
diff --git a/docs/_static/version_names.json b/docs/_static/version_names.json
diff --git a/docs/_templates/custom_sidebar.html b/docs/_templates/custom_sidebar.html
diff --git a/docs/_templates/versions.html b/docs/_templates/versions.html
diff --git a/docs/api/index.md b/docs/api/index.md
@@ -7,8 +7,10 @@ myst:
 
 # RedisVL API
 
+Reference documentation for the RedisVL API.
+
 ```{toctree}
-:caption: RedisVL
+:caption: RedisVL API
 :maxdepth: 2
 
 schema

diff --git a/docs/conf.py b/docs/conf.py
@@ -72,8 +72,7 @@
 # relative to this directory. They are copied after the builtin static files,
 # so a file named "default.css" will overwrite the builtin "default.css".
 html_static_path = ['_static']
-html_css_files=["css/custom.css", "css/sidebar.css"]
-html_js_files=["js/sidebar.js"]
+html_css_files=["css/custom.css"]
 html_title = "RedisVL"
 html_context = {
    "default_mode": "dark"
@@ -86,30 +85,27 @@
     "github_version": "main",
     "doc_path": "docs",
 }
+html_sidebars = {
+    'examples': []
+}
 
-import redisvl
-version = redisvl.__version__
 # This allows us to use ::: to denote directives, useful for admonitions
 myst_enable_extensions = ["colon_fence"]
 myst_heading_anchors = 3
 
 html_theme_options = {
     "logo": {
         "text": "RedisVL",
-        "image_dark": "_static/redis-cube-red-white-rgb.svg",
+        "image_dark": "_static/Redis_Logo_Red_RGB.svg",
         "alt_text": "RedisVL",
     },
     "use_edit_page_button": True,
     "show_toc_level": 4,
-    "show_nav_level": 3,
+    "show_nav_level": 2,
     "navigation_depth": 5,
     "navbar_align": "content",  # [left, content, right] For testing that the navbar items align properly
-    "secondary_sidebar_items": ["page-toc", "edit-this-page", "sourcelink"],
-    "switcher": {
-        "json_url": "_static/version_names.json",
-        "version_match": version,
-    },
-    "navbar_start": ["navbar-logo", "version-switcher"],
+    #"secondary_sidebar_items": ["page-toc", "edit-this-page", "sourcelink"],
+    "navbar_start": ["navbar-logo"],
     "icon_links": [
         {
             "name": "GitHub",
@@ -120,9 +116,6 @@
     ]
 }
 
-html_sidebars = {
-    "**": ["custom_sidebar.html"]
-}
 
 autoclass_content = 'both'
 add_module_names = False

diff --git a/docs/examples/index.md b/docs/examples/index.md
@@ -8,6 +8,8 @@ myst:
 
 # Example Gallery
 
+Explore community examples of RedisVL in the wild.
+
 ```{note}
 If you are using RedisVL, please consider adding your example to this page by
 opening a Pull Request on [GitHub](https://github.com/redis/redis-vl-python)
@@ -17,9 +19,3 @@ opening a Pull Request on [GitHub](https://github.com/redis/redis-vl-python)
 :grid-columns: "1 1 2 2"
 ```
 
-```{toctree}
-:hidden:
-
-openai_qna
-
-```