Skip to content

new chatqna readme template #1755

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged

Conversation

srinarayan-srikanthan
Copy link
Collaborator

Description

New chatqna master readme and xeon readme.

Issues

List the issue or RFC link this PR is working on. If there is no such link, please mark it as n/a.

Type of change

List the type of change like below. Please delete options that are not relevant.

  • Bug fix (non-breaking change which fixes an issue)
  • New feature (non-breaking change which adds new functionality)
  • Breaking change (fix or feature that would break existing design and interface)
  • Others (enhancement, documentation, validation, etc.)

Dependencies

NA

Tests

Describe the tests that you ran to verify your changes.

Copy link

github-actions bot commented Apr 4, 2025

Dependency Review

✅ No vulnerabilities or license issues found.

Scanned Files

None

pre-commit-ci bot and others added 2 commits April 4, 2025 03:05
Signed-off-by: Srinarayan Srikanthan <srinarayan.srikanthan@intel.com>
Copy link
Collaborator

@ftian1 ftian1 left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I am ok with the content, just think shall we have a script to do all instructions in the readme rather than running them one by one manually in the shell?

@joshuayao joshuayao added this to the v1.3 milestone Apr 8, 2025
@joshuayao joshuayao linked an issue Apr 8, 2025 that may be closed by this pull request
4 tasks
@chensuyue
Copy link
Collaborator

@joshuayao
Copy link
Collaborator

Hi @srinarayan-srikanthan could you please resolve the comments? Thanks.

@joshuayao joshuayao self-requested a review April 9, 2025 03:21
@joshuayao
Copy link
Collaborator

@XinyaoWa please help review the FaqGen related content, thanks.

@joshuayao joshuayao requested a review from XinyaoWa April 9, 2025 03:30
@joshuayao joshuayao linked an issue Apr 9, 2025 that may be closed by this pull request
8 tasks
@xiguiw
Copy link
Collaborator

xiguiw commented Apr 9, 2025

Hi Sri,

FagGen is merged into ChatQnA.
We may need to update the new chatqna readme template document to cover FaqGen and ChatQnA.

FYI, here is the issue to be resolved.
#1726

Copy link
Collaborator

@yinghu5 yinghu5 left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM, thank you!

srinarayan-srikanthan and others added 4 commits April 15, 2025 23:01
Signed-off-by: Srinarayan Srikanthan <srinarayan.srikanthan@intel.com>
Signed-off-by: Srinarayan Srikanthan <srinarayan.srikanthan@intel.com>
@poussa
Copy link
Member

poussa commented Apr 16, 2025

Both README.md files have serious formatting issues (check the "View file" option).

Do we need the README_micellaneous.md file? It has duplicate content, text we want to get rid of, images look not very nice, etc.

@srinarayan-srikanthan
Copy link
Collaborator Author

what is the redundancy you are talking about @poussa ?

@lvliang-intel
Copy link
Collaborator

@srinarayan-srikanthan,

please fix pre-commit issue and comments.

image

@xiguiw
Copy link
Collaborator

xiguiw commented Apr 17, 2025

@srinarayan-srikanthan

Shall FagGen be mentioned in this document? FagGen has been merged in ChatQnA

yinghu5 and others added 2 commits April 17, 2025 11:37
@yinghu5
Copy link
Collaborator

yinghu5 commented Apr 17, 2025

@srinarayan-srikanthan,

please fix pre-commit issue and comments.

image

thank you for review. we had fixed it in one commit, but it seems come back again. fix it again just now.

@lvliang-intel lvliang-intel requested a review from xiguiw April 17, 2025 07:54
@lvliang-intel lvliang-intel merged commit 90cfe89 into opea-project:main Apr 17, 2025
9 checks passed
@github-project-automation github-project-automation bot moved this from In review to Done in OPEA Apr 17, 2025
yinghu5 added a commit that referenced this pull request Apr 18, 2025
fix the layout error and address #1755 Monitoring and Tracing link
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation v1.3
Projects
Status: Done
Development

Successfully merging this pull request may close these issues.

[DOC] Need ChatQnA document update FaqGen Information [Doc] Refine the README for ChatQnA