Skip to content

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.

@codecov
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 (b6142fa) to head (b08902b).
⚠️ Report is 33 commits behind head on dev.

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

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.

Copy link
Contributor

@stephprince stephprince left a comment

Choose a reason for hiding this comment

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

Sorry for the delayed approval @magland - looks great!

@stephprince stephprince enabled auto-merge (squash) June 4, 2025 19:19
@stephprince stephprince merged commit cceafe9 into NeurodataWithoutBorders:dev Jun 4, 2025
22 of 25 checks passed
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