Add OSA chat widget to documentation#13702
Open
neuromechanist wants to merge 2 commits intomne-tools:mainfrom
Open
Add OSA chat widget to documentation#13702neuromechanist wants to merge 2 commits intomne-tools:mainfrom
neuromechanist 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. 🚴 |
Contributor
Author
|
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 |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
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)