Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

DOCS-#0000: Adds RunLLM widget to docs #7326

Merged
merged 1 commit into from
Jun 25, 2024

Conversation

vsreekanti
Copy link
Contributor

What do these changes do?

Adds the RunLLM widget, customized to Modin, to the documentation page. RunLLM is a custom technical support assistant that helps developers unblock themselves by answering conceptual questions, generating code, and helping debug.

Here's an example response from RunLLM:
image

Just a note that I put the custom.js file in a new directory called _static, which seems to be the convention for Sphinx, and I updated conf.py accordingly. I didn't see any existing uses of html_static_paths, but please let me know if there's a different preferred organization.

  • first commit message and PR title follow format outlined here

    NOTE: If you edit the PR title to match this format, you need to add another commit (even if it's empty) or amend your last commit for the CI job that checks the PR title to pick up the new PR title.

  • [N/A] passes flake8 modin/ asv_bench/benchmarks scripts/doc_checker.py
  • [N/A] passes black --check modin/ asv_bench/benchmarks scripts/doc_checker.py
  • signed commit with git commit -s
  • [N/A] Resolves #?
  • [N/A] tests added and passing
  • [N/A] module layout described at docs/development/architecture.rst is up-to-date

Signed-off-by: Vikram Sreekanti <vsreekanti@gmail.com>
script.src = "https://cdn.jsdelivr.net/npm/@runllm/search-widget@stable/dist/run-llm-search-widget.es.js";

script.setAttribute("version", "stable");
script.setAttribute("runllm-keyboard-shortcut", "Mod+j"); // cmd-j or ctrl-j to open the widget.
Copy link
Collaborator

Choose a reason for hiding this comment

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

I opened the generated docs for this PR but wasn't able to open the runllm assistant neither with cmd-j nor ctrl-j. How is this supposed to work?

Copy link
Contributor

Choose a reason for hiding this comment

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

@YarShev there's a button on the bottom right of the docs to open the prompt.

@vsreekanti this is a good question, is it possible to test this? When I tried this is the error that I got:
Screenshot 2024-06-25 at 9 35 37 AM

Copy link
Contributor Author

Choose a reason for hiding this comment

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

@sfc-gh-dpetersohn, yes absolutely! We use Recaptcha to prevent spam requests, so we just need to add the URL of the site to the allowed list. Can you share the URL you're testing from?

Copy link
Contributor

Choose a reason for hiding this comment

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

Copy link
Collaborator

Choose a reason for hiding this comment

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

@YarShev there's a button on the bottom right of the docs to open the prompt.

Hm... I don't see any button.

Copy link
Contributor

Choose a reason for hiding this comment

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

Ask AI button in the built docs

Screenshot 2024-06-25 at 1 32 35 PM

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Can you try testing again? Just added both the test domain and the prod domain to our Recaptcha instance!

@@ -0,0 +1,16 @@
document.addEventListener("DOMContentLoaded", function () {
Copy link
Collaborator

Choose a reason for hiding this comment

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

I wonder how many projects already use runllm in their docs?

Copy link
Contributor Author

Choose a reason for hiding this comment

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

We're deployed in a number of locations — here's a few popular examples:

Let me know if there's other context I can provide!

@sfc-gh-dpetersohn sfc-gh-dpetersohn merged commit ea9a4b0 into modin-project:main Jun 25, 2024
8 checks passed
arunjose696 pushed a commit to arunjose696/modin that referenced this pull request Jul 11, 2024
Signed-off-by: Vikram Sreekanti <vsreekanti@gmail.com>
arunjose696 pushed a commit to arunjose696/modin that referenced this pull request Jul 11, 2024
Signed-off-by: Vikram Sreekanti <vsreekanti@gmail.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants