Add OSA chat widget to documentation#13702
Add OSA chat widget to documentation#13702neuromechanist wants to merge 2 commits intomne-tools:mainfrom
Conversation
|
Hello! 👋 Thanks for opening your first pull request here! ❤️ We will try to get back to you soon. 🚴 |
|
Hi maintainers! Could someone approve the CircleCI pipeline? It requires maintainer approval for first-time contributors from forks. Also, if you'd like to customize the widget further (e.g., adding your own logo), you can pass additional options to OSAChatWidget.setConfig({
communityId: 'mne',
logo: 'https://mne.tools/stable/_static/mne_logo.svg',
suggestedQuestions: [...]
});Full configuration reference: https://docs.osc.earth/osa/deployment/widget/#full-configuration |
| @@ -0,0 +1 @@ | |||
| Add OSA chat widget to documentation pages, by `Yahya Shirazi`_. No newline at end of file | |||
There was a problem hiding this comment.
@neuromechanist you need to add your name somewhere as sphinx does not recognize the target Yahya Shirazi
maybe in authors.rst but I don't know what's the recommended way today
There was a problem hiding this comment.
The name would need to be added to doc/changes/names.inc, then in the changelog entry you should link it as :newcontrib:`Yahya Shirazi`. (note the missing underscore).
|
@neuromechanist Thanks for opening this PR. Pushing AI tools is not something that everyone has been fully comfortable with. See for instance this discussion regarding an MCP: #13288 (comment). If I undestand, OSA is more of a chatbot, but still those concerns over the correctness of the bot's answers would apply. One of the suggested prompts And yes, while nobody has to use it, it's inclusion in the documentation is still implicit support that it's answers can be trusted. |
Summary
Details
The widget is a lightweight floating chat button that appears on all documentation pages. It:
mnecommunity configuration from OSAThe widget is served from
demo.osc.earthand configured via thecommunityId: 'mne'setting, which auto-configures the API endpoint, title, theme color, and initial greeting.Test plan
mne.toolsand*.mne.toolsare enabled on the OSA backendmake html)