docs(other): add ai assistant web component docs#317
Closed
SmoliyY wants to merge 3 commits into
Closed
Conversation
![redocly[bot]](https://avatars.githubusercontent.com/in/348054?s=60&v=4){kind=small}
There was a problem hiding this comment.
marketing-site AI Review: 🟢 Completed
Reunite Agent has reviewed your changes and found 10 potential issue(s).
Note
Low Risk
This PR strictly adds a new documentation file and does not modify any source code or application behavior, presenting minimal operational risk.
Overview
Adds comprehensive documentation for the early-access AI assistant web component. The new guide explains how to:
- Embed the component using a CDN script tag and configure essential properties like
api-urlandwelcome-message. - Set up the required
REDOCLY_CORS_ORIGINSenvironment variable for cross-origin requests. - Programmatically control the assistant's visibility via the
window.RedoclyAssistantAPI and listen for state change events. - Customize the component's styling and header icon using CSS custom properties.
Marshevskyy
reviewed
Jun 18, 2026
SmoliyY
force-pushed
the
docs/ai-assistant-web-component
branch
from
a335a36 to
aa533c1
Compare
Contributor
Author
|
This should be here, sorry about confusion. |
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
4 participants
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.
What/Why/How?
Added docs for the
alphaversion of theai-assistantweb component docs.Reference
https://github.com/Redocly/redocly/pull/23965
Testing
Screenshots (optional)
Check yourself
Security