Refine documents for AvatarChatbot. #2077
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
Signed-off-by: ZePan110 <ze.pan@intel.com>
ZePan110
requested review from
ctao456,
lkk12014402 and
XinyuYe-Intel
as code owners
Dependency Review✅ No vulnerabilities or license issues found.Scanned FilesNone |
for more information, see https://pre-commit.ci
There was a problem hiding this comment.
Pull Request Overview
This PR refines and reorganizes documentation for the AvatarChatbot project, providing clearer quick-start guides and a structured root README.
- Reorganized the Intel® Gaudi® and Intel® Xeon® READMEs into numbered quick-start sections with step-by-step deployment instructions.
- Updated the root
AvatarChatbot/README.mdto include a table of contents, architecture overview, and a deployment options table. - Standardized service configuration tables across platform-specific READMEs.
Reviewed Changes
Copilot reviewed 3 out of 3 changed files in this pull request and generated 2 comments.
| File | Description |
|---|---|
| AvatarChatbot/docker_compose/intel/hpu/gaudi/README.md | Added numbered quick-start guide, environment setup, deploy/test/cleanup |
| AvatarChatbot/docker_compose/intel/cpu/xeon/README.md | Mirrored Gaudi guide structure for Xeon, updated steps and tables |
| AvatarChatbot/README.md | Introduced table of contents, architecture section, and deployment table |
Comments suppressed due to low confidence (1)
AvatarChatbot/README.md:3
- [nitpick] Rephrase for clarity: e.g., "This example demonstrates an AI avatar chatbot built with OPEA component-level microservices."
The AvatarChatbot example demonstrates the implementation of AI avatar chatbot using OPEA component-level microservices.
lvliang-intel
approved these changes
Jun 17, 2025
Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>
Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>
yinghu5
approved these changes
Jun 17, 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
Refine documents for AvatarChatbot.
Issues
#1679
Type of change
List the type of change like below. Please delete options that are not relevant.
Dependencies
List the newly introduced 3rd party dependency if exists.
Tests
Describe the tests that you ran to verify your changes.