Skip to content

Conversation

@cszhu
Copy link
Collaborator

@cszhu cszhu commented Dec 3, 2025

Description

This PR integrates the runLLM chat widget into the Ray documentation site, replacing the existing custom "Ask AI" widget. Our new widget appears in the bottom-left corner of all doc pages and will answer questions powered by our runLLM agent.

Changes:

  • Added runllm-widget.js to load and configure the runLLM widget
  • Updated conf.py to include the widget script on all pages
  • Disabled the existing custom "Ask AI" widget (assistant.js)
  • Widget configured with:
    • Assistant name: "Ray RunLLM Bot"
    • Position: Bottom right
    • Keyboard shortcut: Mod+j (Cmd+J / Ctrl+J)

Related issues

N/A - New feature addition

Additional information

Testing:

  • Widget can be tested locally by:
    • building docs with DOC_LIB=data sphinx-build -b html -d _build/doctrees source _build/html
    • or serving with python -m http.server 8000 -d _build/html
  • Widget will appear on all documentation pages once deployed.

Screenshots:
Examples of the widget on various pages:
image
image

Example of widget open (opens an overlay):
image

The existing custom "Ask AI" widget has been disabled but the code remains commented out in case we need to revert.

cszhu added 2 commits December 2, 2025 17:54
Signed-off-by: Christina Zhu <christina@anyscale.com>
Signed-off-by: Christina Zhu <christina@anyscale.com>
@cszhu cszhu requested a review from a team as a code owner December 3, 2025 02:03
Copy link
Contributor

@gemini-code-assist gemini-code-assist bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Code Review

This pull request introduces the RunLLM chat widget to the Ray documentation, replacing the previous 'Ask AI' chatbot. The changes involve adding a new JavaScript file to dynamically load the widget, and updating the Sphinx configuration to include this new script while disabling the old one. The implementation is mostly correct, but I've identified a few areas for improvement in the new JavaScript file concerning best practices, correctness, and maintainability. Specifically, I've suggested using const over var, correcting an invalid attribute value for crossorigin, extracting a magic number into a constant, and simplifying the script by removing a redundant event listener.

Signed-off-by: Christina Zhu <christina@anyscale.com>
@ray-gardener ray-gardener bot added docs An issue or change related to documentation core Issues that should be addressed in Ray Core labels Dec 3, 2025
@cszhu
Copy link
Collaborator Author

cszhu commented Dec 8, 2025

@cristianjd @maxpumperla Just saw you two worked on the last version of Ask AI so requested a review! Msg me if you have any questions :)

@cszhu cszhu requested a review from GokuMohandas December 8, 2025 23:59
Copy link
Contributor

@crypdick crypdick left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

stamp

@cszhu cszhu enabled auto-merge (squash) December 12, 2025 18:03
@github-actions github-actions bot added the go add ONLY when ready to merge, run all tests label Dec 12, 2025
@github-actions github-actions bot disabled auto-merge December 12, 2025 18:27
Signed-off-by: Christina Zhu <christina@anyscale.com>
@cszhu cszhu force-pushed the cszhu/add-runllm-chat-widget branch from 19bd9cc to 6ee3925 Compare December 15, 2025 19:22
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

core Issues that should be addressed in Ray Core docs An issue or change related to documentation go add ONLY when ready to merge, run all tests

Projects

None yet

Development

Successfully merging this pull request may close these issues.

5 participants