Skip to content

Commit 5053103

Browse files
authored
chore: bump version (#1390)
1 parent a1eae57 commit 5053103

File tree

5 files changed

+87
-4
lines changed

5 files changed

+87
-4
lines changed
Lines changed: 64 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,64 @@
1+
=========================
2+
AI chatbot support (beta)
3+
=========================
4+
5+
ScyllaDB Docs integrates with `Biel.ai <https://biel.ai/>`_ to offer a conversational interface for documentation.
6+
7+
The chatbot can answer documentation-related questions and provide relevant links to help users find the information they need quickly.
8+
9+
.. note::
10+
This feature is in beta and disabled by default. It will be gradually enabled for all documentation sites in a future release.
11+
If you want to enable it now, please contact us in Slack (``#scylla-docs`` channel).
12+
13+
Installation
14+
------------
15+
16+
To enable the AI chatbot, update your ``conf.py`` file by setting ``hide_ai_chatbot`` to ``false`` in ``html_theme_options``:
17+
18+
.. code-block:: python
19+
20+
html_theme_options = {
21+
"hide_ai_chatbot": "false"
22+
}
23+
24+
Usage
25+
-----
26+
27+
Once enabled, the Ask AI button will appear in the documentation interface.
28+
Users can click the button to start a conversation, ask questions, and receive responses with relevant documentation links.
29+
30+
.. figure:: images/ai-chatbot.png
31+
32+
Configuration options
33+
---------------------
34+
35+
.. list-table::
36+
:widths: 20 20 20 40
37+
:header-rows: 1
38+
39+
* - Option
40+
- Type
41+
- Default Value
42+
- Description
43+
* - ``hide_ai_chatbot``
44+
- string
45+
- true
46+
- Hides the AI chatbot button in the documentation.
47+
* - ``ai_chatbot_id``
48+
- string
49+
- ddfdo8m94k
50+
- Biel.ai project ID.
51+
52+
Troubleshooting
53+
---------------
54+
55+
If the chatbot does not appear:
56+
57+
* Ensure ``hide_ai_chatbot`` is set to false in html_theme_options.
58+
59+
* Verify that ai_chatbot_id is correctly set to a valid Biel.ai project ID.
60+
61+
* Check for errors in the browser console that may indicate issues with the integration.
62+
63+
For more details, refer to the `Biel.ai documentation <https://docs.biel.ai/>`_.
64+
Loading

docs/source/configuration/index.rst

Lines changed: 4 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -10,6 +10,7 @@ Configuration
1010
multiversion
1111
markdown
1212
redirects
13+
ai-chatbot
1314
search
1415
dependabot
1516

@@ -18,9 +19,11 @@ Configuration
1819
:id: "getting-started"
1920
:class: my-panel
2021

21-
* :doc:`Page options <page>` - Configuration options per page.
2222
* :doc:`Template options <template>` - Configuration options for this theme.
23+
* :doc:`Page options <page>` - Configuration options per page.
2324
* :doc:`Multiversion options <multiversion>` - Configuration options for the multiversion extension.
2425
* :doc:`Markdown support <markdown>` - Extension to write documentation with Markdown.
2526
* :doc:`Redirects support <redirects>` - Extension to create redirects.
27+
* :doc:`AI chatbot support <ai-chatbot>` - AI chatbot for ScyllaDB documentation sites.
2628
* :doc:`Search support <search>` - Service to index content that is searchable across all sites.
29+
* :doc:`Dependabot <dependabot>` - Configuration options for the dependabot extension.

docs/source/upgrade/CHANGELOG.md

Lines changed: 18 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -5,13 +5,29 @@ All notable changes to this project will be documented in this file.
55
The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
66
and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
77

8-
## 1.8.5 - 17 Jan 2024
8+
## 1.8.6 - 1 Apr 2025
9+
10+
### Added
11+
12+
- [#1354](https://github.com/scylladb/sphinx-scylladb-theme/pull/1354): Integrated an AI-powered chatbot to assist users with documentation queries.
13+
14+
### Updated
15+
16+
- [#1379](https://github.com/scylladb/sphinx-scylladb-theme/pull/1379): Updated server link in the header to point to `docs.scylladb.com/manual`.
17+
- [#1368](https://github.com/scylladb/sphinx-scylladb-theme/pull/1368): Added a link to tutorials in the footer and updated the privacy policy disclaimer.
18+
19+
### Fixed
20+
21+
- [#1361](https://github.com/scylladb/sphinx-scylladb-theme/pull/1361): Adjusted hero box spacing on mobile for projects using a landing page.
22+
- [#1369](https://github.com/scylladb/sphinx-scylladb-theme/pull/1369): Fixed an issue with copying anchor links on nested pages.
23+
24+
## 1.8.5 - 17 Jan 2025
925

1026
### Fixed
1127

1228
- [#1336](https://github.com/scylladb/sphinx-scylladb-theme/pull/1336): Fixed an issue where the sidebar menu overlapped the project title.
1329

14-
## 1.8.4 - 17 Jan 2024
30+
## 1.8.4 - 17 Jan 2025
1531

1632
### Added
1733

pyproject.toml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
[tool.poetry]
22
name = "sphinx-scylladb-theme"
3-
version = "1.8.5"
3+
version = "1.8.6"
44
description = "A Sphinx Theme for ScyllaDB documentation projects"
55
authors = ["David García <[email protected]>"]
66
exclude = [".github", "config", "docs", "extensions", ".postcss.config.js", ".prettierrc.json", "deploy.sh", "src", "package.json", "package-lock.json"]

0 commit comments

Comments
 (0)