-
Notifications
You must be signed in to change notification settings - Fork 217
Labels
Backlogfeatures in backlogfeatures in backlogdocumentationImprovements or additions to documentationImprovements or additions to documentation
Milestone
Description
Priority
P0
OS type
Ubuntu
Hardware type
Xeon-GNR
Running nodes
Single Node
Description
The request comes from the documentation task force. The goal of this refinement is to streamline the master README for each components, enhancing the user experience. Each master README will now offer a concise introduction and direct users to specific documentation paths for different aspects such as integrations, hardware, deployment etc.
Please read the guidelines from opea-project/GenAIExamples#1673 for the refinement. Although the guideline is specific for examples, we can refer this to refine big master README(> 2 screens/pages). For the small master README files, just check the content and fix typos.
Please note that we need to add the link of k8s deployment into the master README if it exists.
Sub-issues
Metadata
Metadata
Assignees
Labels
Backlogfeatures in backlogfeatures in backlogdocumentationImprovements or additions to documentationImprovements or additions to documentation