Add AI management Chat Widget Documentation #24397
Merged
Conversation
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
Added documentation and image for the AI Management chat widget, including usage examples and JavaScript API details. Improved table formatting and consistency throughout the AI Management module documentation for better readability.
Contributor
|
Images automagically compressed by Calibre's image-actions ✨ Compression reduced images by 74.3%, saving 10.6 KB.
|
Contributor
There was a problem hiding this comment.
Pull request overview
This pull request adds comprehensive documentation for the AI Management module's Chat Widget feature to the existing AI Management documentation. The changes focus on documenting the ChatClientChatViewComponent from the Volo.AIManagement.Client.Web package, which provides a ready-to-use chat interface for integrating AI capabilities into MVC applications.
Key Changes
- Added detailed documentation for the Chat Widget component, including basic usage, customization properties, conversation persistence, and JavaScript API
- Included a screenshot demonstrating the chat widget's appearance
- Made formatting improvements to existing tables and spacing throughout the document for better readability
Reviewed changes
Copilot reviewed 1 out of 2 changed files in this pull request and generated 10 comments.
| File | Description |
|---|---|
docs/en/modules/ai-management/index.md |
Added new "Client Usage (MVC UI)" section with Chat Widget documentation including properties, usage examples, conversation persistence, and JavaScript API reference. Also includes minor formatting improvements to tables and spacing. |
docs/en/images/ai-management-widget.png |
Added screenshot showing the Chat Widget UI component in action. |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
Updated the documentation to better explain the distinction between `Volo.AIManagement.*` and `Volo.AIManagement.Client.*` packages, detailing their intended usage scenarios and roles.
Expanded the JavaScript API documentation for chat components to clarify initialization timing and added best-practice examples for accessing components after user interaction, rather than at page load.
Co-authored-by: Copilot <[email protected]>
EngincanV
approved these changes
Dec 12, 2025
hikalkan
approved these changes
Dec 12, 2025
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.
Description
Add Chat Widget usage to the AI Management documentation
Checklist