[DOCS][Libraries] standardize Chat Q&A instances in the Sample Applications folder (open-edge-platform#2086)

jbuksinski-intel · wiwaszko-intel · web-flow · commit b4640b6d2c16 · 2026-04-07T10:51:36.000+02:00
Co-authored-by: Wiktor Iwaszko &lt;wiktorx.iwaszko@intel.com&gt;
diff --git a/microservices/document-ingestion/pgvector/README.md b/microservices/document-ingestion/pgvector/README.md
@@ -36,7 +36,7 @@ Guidance for Authors:
 -->
 ## Example Use Case
 
-- **Use Case 1**: Refer to the [ChatQnA](https://docs.openedgeplatform.intel.com/dev/edge-ai-libraries/chat-question-and-answer/index.html) sample application where this microservice is used.
+- **Use Case 1**: Refer to the [Chat Q&A](https://docs.openedgeplatform.intel.com/dev/edge-ai-libraries/chat-question-and-answer/index.html) sample application where this microservice is used.
 
 
 <!--
diff --git a/microservices/document-ingestion/pgvector/docs/user-guide/how-to-customize.md b/microservices/document-ingestion/pgvector/docs/user-guide/how-to-customize.md
@@ -84,4 +84,4 @@ source ./run.sh --build dataprep my-registry/my-dataprep:v1.0
 ## Common Customizations
 
 Customization options are currently provided in the context of the sample application. Refer
-to [ChatQnA sample application](https://docs.openedgeplatform.intel.com/dev/edge-ai-libraries/chat-question-and-answer/index.html) for details like Helm and customization options.
+to [Chat Q&A sample application](https://docs.openedgeplatform.intel.com/dev/edge-ai-libraries/chat-question-and-answer/index.html) for details like Helm and customization options.
diff --git a/microservices/document-ingestion/pgvector/docs/user-guide/index.md b/microservices/document-ingestion/pgvector/docs/user-guide/index.md
@@ -30,7 +30,7 @@ vectorDB and minIO is used as the data store.
 ## Example Use Case
 
 **Use Case 1**: Refer to the
-[ChatQnA](https://docs.openedgeplatform.intel.com/dev/edge-ai-libraries/chat-question-and-answer/index.html)
+[Chat Q&A](https://docs.openedgeplatform.intel.com/dev/edge-ai-libraries/chat-question-and-answer/index.html)
 sample application where this microservice is used.
 
 ### High-Level System View Diagram
diff --git a/microservices/model-download/docs/user-guide/get-started/deploy-with-helm-chart.md b/microservices/model-download/docs/user-guide/get-started/deploy-with-helm-chart.md
@@ -88,7 +88,7 @@ The following is a summary of key configuration options available in the `values
 helm install model-download . -n <your-namespace>
 ```
 
-> **Note:** `model-download` creates and manages a shared PVC that can be used by dependent applications such as ChatQnA.
+> **Note:** `model-download` creates and manages a shared PVC that can be used by dependent applications such as Chat Q&A.
 
 ## Verify the Deployment
 
diff --git a/sample-applications/chat-question-and-answer-core/docs/user-guide/benchmarks.md b/sample-applications/chat-question-and-answer-core/docs/user-guide/benchmarks.md
@@ -1,6 +1,6 @@
 # Benchmarks
 
-This document provides reference benchmark results for the ChatQ&A sample application. The benchmark numbers published here are indicative of the performance to be expected on given test environment.
+This document provides reference benchmark results for the Chat Question & Answer (Chat Q&A) Sample Application. The benchmark numbers published here are indicative of the performance to be expected on given test environment.
 
 ## Test Environment
 
diff --git a/sample-applications/chat-question-and-answer-core/docs/user-guide/deploy-with-helm.md b/sample-applications/chat-question-and-answer-core/docs/user-guide/deploy-with-helm.md
@@ -13,7 +13,7 @@ Before you begin, ensure that you have the following prerequisites:
 
 ## Steps to deploy with Helm
 
-You can deploy the ChatQ&A Core application using `Helm` in **two ways**: by pulling the Helm chart from Docker Hub or by building it from the source code. Follow the steps below based on your preferred method.
+You can deploy the Chat Q&A Core application using `Helm` in **two ways**: by pulling the Helm chart from Docker Hub or by building it from the source code. Follow the steps below based on your preferred method.
 
 **_Note: Steps 1–3 differ depending on whether you choose to pull the chart or build it from source._**
 
diff --git a/sample-applications/chat-question-and-answer-core/docs/user-guide/get-started.md b/sample-applications/chat-question-and-answer-core/docs/user-guide/get-started.md
@@ -1,6 +1,6 @@
 # Get Started
 
-The ChatQ&A Sample Application is a Retrieval Augmented Generation (RAG) pipeline designed to be used in a single user non concurrent deployment primarily targeting  Intel® Core&trade; deployments.  The application is intended to help developers create personal intelligent chatbots that can answer questions based on their private data. This guide will help you set up, run, and modify the ChatQ&A Sample Application on Intel Edge AI systems.
+The Chat Question & Answer (Chat Q&A) Sample Application is a Retrieval Augmented Generation (RAG) pipeline designed to be used in a single user non concurrent deployment primarily targeting  Intel® Core&trade; deployments.  The application is intended to help developers create personal intelligent chatbots that can answer questions based on their private data. This guide will help you set up, run, and modify the Chat Q&A Sample Application on Intel Edge AI systems.
 
 By following this guide, you will learn how to:
 
@@ -39,7 +39,7 @@ By following this guide, you will learn how to:
 
 3. **Configure Image Pulling Registry and Tag Environment Variables**:
 
-   To utilize the release images for the ChatQ&A sample application from the registry, set the following environment variables:
+   To utilize the release images for the Chat Q&A sample application from the registry, set the following environment variables:
 
    ```bash
    export REGISTRY="intel/"
diff --git a/sample-applications/chat-question-and-answer-core/docs/user-guide/index.md b/sample-applications/chat-question-and-answer-core/docs/user-guide/index.md
@@ -11,7 +11,7 @@
 </div>
 hide_directive-->
 
-ChatQ&A sample application is a foundational Retrieval Augmented Generation (RAG) pipeline,
+Chat Question & Answer (Chat Q&A) Sample Application is a foundational Retrieval Augmented Generation (RAG) pipeline,
 enabling users to ask questions and receive answers including on their own private data
 corpus. The sample application demonstrates how to build RAG pipelines.
 Compared to the
@@ -67,7 +67,7 @@ more information on the Ollama framework, visit its
 The Chat Question-and-Answer Core sample application consists of two main parts:
 
 1. **Data Ingestion [Knowledge Building]**: This part is responsible for adding
-   documents to the ChatQ&A instance. The data ingestion step allows ingestion of
+   documents to the Chat Q&A instance. The data ingestion step allows ingestion of
    common document formats like pdf and doc. The ingestion process cleans and formats
    the input document, creates embeddings of the documents using embedding microservice,
    and stores them in the preferred vector database. CPU version of
diff --git a/sample-applications/chat-question-and-answer-core/docs/user-guide/release-notes.md b/sample-applications/chat-question-and-answer-core/docs/user-guide/release-notes.md
@@ -40,7 +40,7 @@
 **Version**: 1.2.1 \
 **Release Date**: WW27 2025
 
-- Image Optimization for ChatQnA Core Backend. Reducing image sizes, which will lead to faster processing times and reduced bandwidth usage.
+- Image Optimization for Chat Q&A Core Backend. Reducing image sizes, which will lead to faster processing times and reduced bandwidth usage.
 - Security Vulnerabilities Fix for Dependency Packages.
 - Update in Setup Scripts for default model download path in the backend.
 - Bug fixes.
diff --git a/sample-applications/chat-question-and-answer-core/tests/README.md b/sample-applications/chat-question-and-answer-core/tests/README.md
@@ -1,6 +1,6 @@
-# Running Tests for ChatQnA-Core
+# Running Tests for Chat Q&A Core
 
-This guide will help you run the tests for the ChatQnA-Core project using the pytest framework.
+This guide will help you run the tests for the Chat Q&A Core project using the pytest framework.
 
 ---
 
diff --git a/sample-applications/chat-question-and-answer/docs/user-guide/benchmarks.md b/sample-applications/chat-question-and-answer/docs/user-guide/benchmarks.md
@@ -1,6 +1,6 @@
 # Benchmarks
 
-This document provides reference benchmark results for the ChatQ&A sample application. The benchmark numbers published here are indicative of the performance to be expected on given test environment.
+This document provides reference benchmark results for the Chat Question & Answer (Chat Q&A) Sample Application. The benchmark numbers published here are indicative of the performance to be expected on given test environment.
 
 ## Test Environment
 
diff --git a/sample-applications/chat-question-and-answer/docs/user-guide/get-started.md b/sample-applications/chat-question-and-answer/docs/user-guide/get-started.md
@@ -4,7 +4,7 @@
 **Sample Description**: Provide a brief overview of the application and its purpose.
 -->
 
-The ChatQ&A Sample Application is a modular Retrieval Augmented Generation (RAG) pipeline designed to help developers create intelligent chatbots that can answer questions based on enterprise data. This guide will help you set up, run, and modify the ChatQ&A Sample Application on Intel Edge AI systems.
+The Chat Question & Answer (Chat Q&A) Sample Application is a modular Retrieval Augmented Generation (RAG) pipeline designed to help developers create intelligent chatbots that can answer questions based on enterprise data. This guide will help you set up, run, and modify the Chat Q&A Sample Application on Intel Edge AI systems.
 
 <!--
 **What You Can Do**: Highlight the developer workflows supported by the guide.
diff --git a/sample-applications/chat-question-and-answer/docs/user-guide/get-started/build-from-source.md b/sample-applications/chat-question-and-answer/docs/user-guide/get-started/build-from-source.md
@@ -1,6 +1,6 @@
 # Build from Source
 
-This guide provides step-by-step instructions for building the ChatQ&A Sample Application from source.
+This guide provides step-by-step instructions for building the Chat Q&A Sample Application from source.
 
 > **Note:**
 >
@@ -18,7 +18,7 @@ Before you begin, ensure that you have the following prerequisites:
 ## Steps to Build from Source
 
 1. **Clone the Repository**:
-    - Clone the ChatQ&A Sample Application repository:
+    - Clone the Chat Q&A Sample Application repository:
 
       ```bash
       # Clone the latest on mainline
@@ -89,7 +89,7 @@ Before you begin, ensure that you have the following prerequisites:
     ```
 
 5. **Build the Docker Image**:
-    - Build the Docker image for the ChatQ&A Sample Application:
+    - Build the Docker image for the Chat Q&A Sample Application:
 
       ```bash
       docker compose build
diff --git a/sample-applications/chat-question-and-answer/docs/user-guide/get-started/deploy-with-edge-orchestrator.md b/sample-applications/chat-question-and-answer/docs/user-guide/get-started/deploy-with-edge-orchestrator.md
@@ -12,7 +12,7 @@ Edge Orchestrator, part of Intel’s Edge Software, simplifies edge application
 
 - **Flexible Configuration**: From organizing your physical infrastructure to managing the permutations of executing applications in a variety of runtime environments, Edge Orchestrator gives you the flexibility to define the policies, criteria, and hierarchies that make the most sense for your specific business needs.
 
-To deploy the **ChatQ&A** Application with the Edge Orchestrator, follow the steps described in this document.
+To deploy the **Chat Question & Answer (Chat Q&A)** Sample Application with the Edge Orchestrator, follow the steps described in this document.
 
 ## Procedure to Deploy with Edge Orchestrator
 
@@ -24,7 +24,7 @@ To deploy the **ChatQ&A** Application with the Edge Orchestrator, follow the ste
 
 ### Making the Deployment Package Available
 
-1. Clone the **ChatQ&A** repository:
+1. Clone the **Chat Q&A** repository:
 
     ```bash
     # Clone the latest on mainline
@@ -41,7 +41,7 @@ To deploy the **ChatQ&A** Application with the Edge Orchestrator, follow the ste
 
 1. Once the deployment package has been imported into the Edge Orchestrator, you can see it in the list of Web UI as shown here.
 
-    **![ChatQnA Image](../_assets/chatqna-emf.png)**
+    **![Chat Q&A Image](../_assets/chatqna-emf.png)**
 
 See [Deployment Packages](https://docs.openedgeplatform.intel.com/edge-manage-docs/dev/user_guide/package_software/deploy_packages.html#view-deployment-packages) for more information on deployment packages.
 
@@ -73,16 +73,16 @@ After a few minutes, the deployment will start and will take about 5 minutes to
 
 In the Edge Orchestrator Web UI, you can track the application installation through the [View Deployment Details](https://docs.openedgeplatform.intel.com/edge-manage-docs/dev/user_guide/package_software/deployment_details.html#view-deployment-details) view.
 
-The **ChatQ&A** Sample Application is fully deployed when the applications become green and the status is shown as _Running_.
+The **Chat Q&A** Sample Application is fully deployed when the applications become green and the status is shown as _Running_.
 
 You can view the deployment status on the Deployments page.
 
 > Note: If the deployment fails for any reason, the deployment status will display the “Error” or “Down” status.
 
 For more information on setting up a deployment, see [Set up a Deployment](https://docs.openedgeplatform.intel.com/edge-manage-docs/dev/user_guide/package_software/setup_deploy.html#set-up-a-deployment).
 
-### Access the **ChatQ&A** AI-Suite
+### Access the **Chat Q&A** AI-Suite
 
 1. Download the kubeconfig of the cluster of the Edge Node on which the Application has been deployed. Refer [Kubeconfig Download](https://docs.openedgeplatform.intel.com/edge-manage-docs/dev/user_guide/set_up_edge_infra/clusters/accessing_clusters.html).
 
-2. Follow the steps described in the **ChatQ&A** [Documentation](deploy-with-helm.md#step-6-verify-the-deployment) to proceed to using the application.
+2. Follow the steps described in the **Chat Q&A** [Documentation](deploy-with-helm.md#step-6-verify-the-deployment) to proceed to using the application.
diff --git a/sample-applications/chat-question-and-answer/docs/user-guide/get-started/deploy-with-helm.md b/sample-applications/chat-question-and-answer/docs/user-guide/get-started/deploy-with-helm.md
@@ -1,6 +1,6 @@
 # Deploy with Helm
 
-This guide provides step-by-step instructions for deploying the ChatQ&A Sample Application using Helm.
+This guide provides step-by-step instructions for deploying the Chat Question & Answer (Chat Q&A) Sample Application using Helm.
 
 ## Prerequisites
 
diff --git a/sample-applications/chat-question-and-answer/docs/user-guide/how-it-works.md b/sample-applications/chat-question-and-answer/docs/user-guide/how-it-works.md
diff --git a/sample-applications/chat-question-and-answer/docs/user-guide/how-to-performance.md b/sample-applications/chat-question-and-answer/docs/user-guide/how-to-performance.md
diff --git a/sample-applications/chat-question-and-answer/docs/user-guide/release-notes/release-notes-2025.md b/sample-applications/chat-question-and-answer/docs/user-guide/release-notes/release-notes-2025.md
diff --git a/sample-applications/chat-question-and-answer/tests/unit_tests/README.md b/sample-applications/chat-question-and-answer/tests/unit_tests/README.md
diff --git a/sample-applications/chat-question-and-answer/ui/react/README.md b/sample-applications/chat-question-and-answer/ui/react/README.md
