add nwb assistant to home page of docs #2076
Open
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Motivation
At the recent NWB Docathon I created this AI assistant for NWB. This PR adds a button "Open Assistant" to the home page of the rendered docs, as shown:
When the user clicks the button, it opens NWB Assistant in an iframe, as shown:
For the user, the basic (cheaper) models are available for free. If they want to use the more advanced/expensive models, they need to put in their own openrouter key. There are instructions in the assistant app.
How to test the behavior?
Build the docs using
cd docs && make html
. Then host locally viapython3 -m http.server 8000 --directory _build/html
.Checklist
ruff check . && codespell
from the source directory.