-
Notifications
You must be signed in to change notification settings - Fork 651
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
DOCS-#0000: Adds RunLLM widget to docs #7326
Conversation
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. |
There was a problem hiding this comment.
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?
There was a problem hiding this comment.
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:
There was a problem hiding this comment.
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?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
https://modin--7326.org.readthedocs.build/en/7326/
This is the PR docs build
There was a problem hiding this comment.
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.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
There was a problem hiding this comment.
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 () { |
There was a problem hiding this comment.
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?
There was a problem hiding this comment.
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!
Signed-off-by: Vikram Sreekanti <vsreekanti@gmail.com>
Signed-off-by: Vikram Sreekanti <vsreekanti@gmail.com>
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:
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 updatedconf.py
accordingly. I didn't see any existing uses ofhtml_static_paths
, but please let me know if there's a different preferred organization.flake8 modin/ asv_bench/benchmarks scripts/doc_checker.py
black --check modin/ asv_bench/benchmarks scripts/doc_checker.py
git commit -s
docs/development/architecture.rst
is up-to-date