Skip to content

Commit 6ebae99

Browse files
Refine doc for Productivity Suite (#2069)
Signed-off-by: ZePan110 <[email protected]> Co-authored-by: pre-commit-ci[bot] <66853113+pre-commit-ci[bot]@users.noreply.github.com>
1 parent 8b3f9f3 commit 6ebae99

File tree

2 files changed

+189
-445
lines changed

2 files changed

+189
-445
lines changed

ProductivitySuite/README.md

Lines changed: 12 additions & 26 deletions
Original file line numberDiff line numberDiff line change
@@ -2,6 +2,13 @@
22

33
Productivity Suite, a tool designed to streamline your workflow and boost productivity! Our application leverages the power of OPEA microservices to deliver a comprehensive suite of features tailored to meet the diverse needs of modern enterprises.
44

5+
## Table of contents
6+
7+
1. [Architecture](#architecture)
8+
2. [Deployment Options](#deployment-options)
9+
10+
## Architecture
11+
512
The ProductivitySuite example is implemented using both megaservices and the component-level microservices defined in [GenAIComps](https://github.com/opea-project/GenAIComps). The flow chart below shows the information flow between different megaservices and microservices for this example. Prompt Registry and Chat History microservices save prompt and chat history from the ChatQnA MegaService only into the database.
613

714
```mermaid
@@ -140,31 +147,10 @@ flowchart LR
140147

141148
---
142149

143-
## 🛠️ Key Features
144-
145-
### 💬 Chat with Documents
146-
147-
Engage in intelligent conversations with your documents using our advanced **Retrieval-Augmented Generation (RAG)** capabilities. Ask questions, receive relevant information, and gain insights from your documents in real-time!
148-
149-
### 📄 Content Summarization
150-
151-
Summarize lengthy documents or articles, enabling you to grasp key takeaways quickly. Save time and effort with our intelligent summarization feature!
152-
153-
### 💻 Code Generation
154-
155-
Boost your coding productivity by providing a description of the functionality you require. Our application generates corresponding code snippets, saving you valuable time and effort!
156-
157-
### 🎛️ User Context Management
158-
159-
Maintain a seamless workflow by managing your user's context within the application. Our context management system keeps track of documents and chat history for a personalized experience.
160-
161-
### 🔐 Identity and Access Management
162-
163-
Utilizes the open-source platform **Keycloak** for single sign-on identity and access management. This ensures secure and convenient access to your productivity tools.
164-
165-
---
150+
## Deployment Options
166151

167-
## 📚 Setup Guide
152+
The table below lists the available deployment options and their implementation details for different hardware platforms.
168153

169-
- **[Keycloak Configuration Guide](./docker_compose/intel/cpu/xeon/keycloak_setup_guide.md)**: Instructions to set up Keycloak for identity and access management.
170-
- **[Xeon Guide](./docker_compose/intel/cpu/xeon/README.md)**: Instructions to build Docker images from source and run the application via Docker Compose.
154+
| Platform | Deployment Method | Link |
155+
| ---------- | ----------------- | --------------------------------------------------------------- |
156+
| Intel Xeon | Docker compose | [Deployment on Xeon](./docker_compose/intel/cpu/xeon/README.md) |

0 commit comments

Comments
 (0)