Skip to content

add nwb assistant to home page of docs #2076

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

Open
wants to merge 2 commits into
base: dev
Choose a base branch
from

Conversation

magland
Copy link
Contributor

@magland magland commented May 7, 2025

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:

image

When the user clicks the button, it opens NWB Assistant in an iframe, as shown:

image

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 via python3 -m http.server 8000 --directory _build/html.

Checklist

  • Did you update CHANGELOG.md with your changes?
  • Have you checked our Contributing document?
  • Have you ensured the PR clearly describes the problem and the solution?
  • Is your contribution compliant with our coding style? This can be checked running ruff check . && codespell from the source directory.
  • Have you checked to ensure that there aren't other open Pull Requests for the same change?
  • Have you included the relevant issue number using "Fix #XXX" notation where XXX is the issue number? By including "Fix #XXX" you allow GitHub to close issue #XXX when the PR is merged.

Copy link

codecov bot commented May 7, 2025

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 94.83%. Comparing base (f52d327) to head (584f6c5).

Additional details and impacted files
@@           Coverage Diff           @@
##              dev    #2076   +/-   ##
=======================================
  Coverage   94.83%   94.83%           
=======================================
  Files          28       28           
  Lines        2750     2750           
  Branches      708      708           
=======================================
  Hits         2608     2608           
  Misses         82       82           
  Partials       60       60           
Flag Coverage Δ
integration 74.18% <ø> (ø)
unit 84.83% <ø> (ø)

Flags with carried forward coverage won't be shown. Click here to find out more.

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

🚀 New features to boost your workflow:
  • ❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.

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