GenAIExamples icon indicating copy to clipboard operation
GenAIExamples copied to clipboard
Published 2 months ago • verified publisher icon opea-project

Docs: improve organization and instructions on ChatQnA Readme

Open mkbhanda opened this issue 1 year ago • 1 comments

https://github.com/opea-project/GenAIExamples/edit/main/ChatQnA/README.md

Please re-organize the material to clearly demarcate

  1. what is the chatQnA pipeline
  2. deployment options: Docker versus Kubernetes or orchestration option
  3. deployment hardware options: Xeon, Gaudi, Nvidia GPU etc

For instance, there are instructions on environment variable set up, is it specific to docker deployments only? Are they relevant to Kubernetes?

With and without GMC on Kubernetes, it is confusing when a link points to different places but reads the same as Kubernetes install. Change the link text appropriately.

mkbhanda avatar Aug 12 '24 09:08 mkbhanda

@tomlenth please help on this issue.

mkbhanda avatar Aug 12 '24 09:08 mkbhanda

@mkbhanda @tomlenth

What is the status now? Could this be closed?

xiguiw avatar Mar 05 '25 02:03 xiguiw

Will check latest tomorrow.

mkbhanda avatar Mar 05 '25 05:03 mkbhanda

Hi @mkbhanda and doc team, please help to consider the request with latest doc updates. thank you [remind]

yinghu5 avatar Mar 25 '25 07:03 yinghu5

https://github.com/opea-project/GenAIExamples/pull/1755

yinghu5 avatar Apr 17 '25 02:04 yinghu5

Hi @mkbhanda and All thank you much for raising the issue! The doc team refined the Readme of ChatQnA and other 7 example for 1.3 release, https://opea-project.github.io/latest/GenAIExamples/ChatQnA/README.html will to improve the Readme for more examples in later version. I close the issue. please feel free to let us know if any improvement suggestion.

yinghu5 avatar May 16 '25 05:05 yinghu5