Merge pull request #1492 from scylladb/master

Sync release

Author: dgarcia360

.github/workflows/codeql-analysis.yaml

@@ -38,7 +38,7 @@ jobs:
 
     steps:
       - name: Checkout repository
-        uses: actions/checkout@v4
+        uses: actions/checkout@v5
 
       # Initializes the CodeQL tools for scanning.
       - name: Initialize CodeQL

.github/workflows/docs-links.yaml

@@ -12,14 +12,14 @@ jobs:
     runs-on: ubuntu-latest
     steps:
       - name: Checkout
-        uses: actions/checkout@v4
+        uses: actions/checkout@v5
         with:
           persist-credentials: false
           fetch-depth: 0
 
       - name: Link Checker
         id: lychee
-        uses: lycheeverse/lychee-action@v2.4.1
+        uses: lycheeverse/lychee-action@v2.6.1
         with:
           args: --verbose --no-progress './**/*.md' './**/*.rst'
         env:

.github/workflows/docs-pages.yaml

@@ -16,7 +16,7 @@ jobs:
     runs-on: ubuntu-latest
     steps:
       - name: Checkout
-        uses: actions/checkout@v4
+        uses: actions/checkout@v5
         with:
           ref: ${{ github.event.repository.default_branch }}
           persist-credentials: false

.github/workflows/docs-pr.yaml

@@ -14,7 +14,7 @@ jobs:
     runs-on: ubuntu-latest
     steps:
       - name: Checkout
-        uses: actions/checkout@v4
+        uses: actions/checkout@v5
         with:
           persist-credentials: false
           fetch-depth: 0

.github/workflows/multiversion-tests.yaml

@@ -20,7 +20,7 @@ jobs:
         working-directory: ./extensions/sphinx-multiversion
     steps:
       - name: Checkout
-        uses: actions/checkout@v4
+        uses: actions/checkout@v5
         with:
           persist-credentials: false
           fetch-depth: 0

.github/workflows/theme-tests.yaml

@@ -17,7 +17,7 @@ jobs:
     runs-on: ubuntu-latest
     steps:
       - name: Checkout
-        uses: actions/checkout@v4
+        uses: actions/checkout@v5
         with:
           persist-credentials: false
           fetch-depth: 0

docs/source/examples/hero-box.rst

@@ -87,6 +87,11 @@ The ``hero-box`` directive supports the following options:
     -
     -
     - If present, adds vertical padding suitable for content pages. By default (without this flag), the hero box is optimized for landing pages.
+  * - ``ai_chatbot_id``
+    - string
+    -
+    - my-chatbot-id
+    - AI chatbot ID to use for the Ask AI button. Requires the ``search_box`` option to be present.
 
 Link resolution
 ---------------
@@ -220,6 +225,29 @@ Results in:
     :search_box:
     :content_page:
 
+With custom AI chatbot ID
+..........................
+
+Using:
+
+.. code-block:: rst
+
+    .. hero-box::
+        :title: Lorem Ipsum
+        :text: Lorem ipsum dolor sit amet, consectetur adipiscing elit.
+        :search_box:
+        :ai_chatbot_id: my-custom-chatbot-id
+        :content_page:
+
+Results in:
+
+.. hero-box::
+    :title: Lorem Ipsum
+    :text: Lorem ipsum dolor sit amet, consectetur adipiscing elit.
+    :search_box:
+    :ai_chatbot_id: ddfdo8m94k
+    :content_page:
+
 With bold button
 .................
 

docs/source/index.rst

@@ -12,10 +12,10 @@
 .. hero-box::
   :button_icon: icon-github
   :button_style: bold
-  :button_url: https://github.com/scylladb/sphinx-scylladb-theme
-  :button_text: Source code
   :title: Welcome to ScyllaDB Sphinx Theme documentation
   :image: /_static/img/mascots-2/docs.svg
+  :search_box:
+  :ai_chatbot_id: ddfdo8m94k
 
   The documentation toolchain for ScyllaDB projects.
 

docs/source/upgrade/CHANGELOG.md

@@ -5,6 +5,23 @@ All notable changes to this project will be documented in this file.
 The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
 and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
 
+
+## 1.8.8 - 2 September 2025
+
+### Added
+
+- [#1485](https://github.com/scylladb/sphinx-scylladb-theme/pull/1485): Added Ask AI button in the header and hero box component for easier access to AI-powered documentation assistance.
+- [#1476](https://github.com/scylladb/sphinx-scylladb-theme/pull/1476): Introduced support for defining MyST substitutions per version in multiversion builds.
+
+### Updated
+
+- [#1463](https://github.com/scylladb/sphinx-scylladb-theme/pull/1463): Updated download link in the header navigation.
+
+### Fixed
+
+- [#1458](https://github.com/scylladb/sphinx-scylladb-theme/pull/1458): Fixed highlight color rendering issues in dark mode.
+
+
 ## 1.8.7 - 1 July 2025
 
 ### Added

extensions/sphinx-multiversion/README.md

@@ -58,6 +58,7 @@ See https://github.com/scylladb/sphinx-scylladb-theme/pull/891
 The following properties can be defined on a per-version basis.
 
 * `rst_prolog`
+* `myst_substitutions`: Introduced in 0.3.3
 * `exclude_patterns`: Introduced in 0.3.2
 
 ## License