[doc] Refactor the online doc, simple the sidebar #267
+149
−110
Conversation
This file contains 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
NeoZhangJianyu
requested review from
chensuyue,
ftian1,
mkbhanda,
preethivenkatesh,
chickenrae and
tomlenth
as code owners
louie-tsai
approved these changes
Jan 16, 2025
| @@ -45,7 +45,7 @@ The ChatQnA example is designed to be a simple, yet powerful, demonstration of | |||
| the RAG architecture. It is a great starting point for developers looking to | |||
| build chatbots that can provide accurate and up-to-date information to users. | |||
|
|
|||
| To facilitate sharing of individual services across multiple GenAI applications, use the GenAI Microservices Connector (GMC) to deploy your application. Apart from service sharing , it also supports specifying sequential, parallel, and alternative steps in a GenAI pipeline. In so doing, it supports dynamic switching between models used in any stage of a GenAI pipeline. For example, within the ChatQnA pipeline, using GMC one could switch the model used in the embedder, re-ranker, and/or the LLM. | |||
| To facilitate sharing of individual services across multiple GenAI applications, use the GenAI Microservices Connector (GMC) to deploy your application. Apart from service sharing , it also supports specifying sequential, parallel, and alternative steps in a GenAI pipeline. In so doing, it supports dynamic switching between models used in any stage of a GenAI pipeline. For example, within the ChatQnA pipeline, using GMC one could switch the model used in the embedder, re-ranker, and/or the LLM. | |||
| Upstream Vanilla Kubernetes or Red Hat OpenShift Container | |||
| Platform (RHOCP) can be used with or without GMC, while use with GMC provides additional features. | |||
|
|
|||
There was a problem hiding this comment.
chatqna_flow_chat.png might be duplicated with mermaid workflow chat. might be good to keep one.
|
|
||
| Single Node | ||
| *********** | ||
|
|
||
| .. toctree:: | ||
| :maxdepth: 1 | ||
| :glob: |
There was a problem hiding this comment.
this looks like a duplication with the session under Projects.
ex:
http://tgl-gen12-tce.sh.intel.com:8000/latest/examples/ChatQnA/deploy/xeon.html
http://tgl-gen12-tce.sh.intel.com:8000/latest/GenAIExamples/ChatQnA/docker_compose/intel/cpu/xeon/README.html
| @@ -9,7 +9,7 @@ AgentQnA Sample Guide | |||
| Overview | |||
| ******** | |||
|
|
|||
| This example showcases a hierarchical multi-agent system for question-answering applications. | |||
| This example showcases a hierarchical multi-agent system for question-answering applications. | |||
|
|
|||
| Purpose | |||
| ******* | |||
There was a problem hiding this comment.
possible to use same mermaid workflow from github readme?
|
@NeoZhangJianyu possible to address the feedbacks? hope to get merged into 1.2 |
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.
Refactor the online doc structure.
Hope this is the new base of online doc, so that more improvement/refactor could be handled based it.
The reviewer could create comments or update the branch directly.
Here is my updated online doc demo: http://tgl-gen12-tce.sh.intel.com:8000/latest/index.html. All update will be shown in this demo web site. Please compare with current online doc: https://opea-project.github.io/latest/index.html.
Update list:
Update the structure of documents in online doc page. No any content is changed.
Reduce the navigator depth to 2 in sidebar.
Move GenAI* to first level directory: projects.
Short the first level directory's' name
Every first level directory has one entry page. All other pages in this directory should be linked in the entry page or sub linked pages.
Add first level directory:
Ignore some warnings which block online doc building.
This refactor make some documents can't be navigated in online doc website. If we need these documents, we must update the Entry page or sub linked pages to add link to them. When add link of missed pages, please check if the content is duplicated.
The building time of online doc is shorted from 2 mins to 10 seconds.
Rm the tailed space of lines.