Update docs

Author: pamelafox

README.md

@@ -9,9 +9,9 @@ This project is designed for deployment to Azure using [the Azure Developer CLI]
 
 * [Features](#features)
 * [Getting started](#getting-started)
-    * [GitHub Codespaces](#github-codespaces)
-    * [VS Code Dev Containers](#vs-code-dev-containers)
-    * [Local environment](#local-environment)
+  * [GitHub Codespaces](#github-codespaces)
+  * [VS Code Dev Containers](#vs-code-dev-containers)
+  * [Local environment](#local-environment)
 * [Deployment](#deployment)
 * [Local development](#local-development)
 * [Costs](#costs)
@@ -27,7 +27,13 @@ This project provides the following features:
 * OpenAI function calling to optionally convert user queries into query filter conditions, such as turning "Climbing gear cheaper than $30?" into "WHERE price < 30".
 * Conversion of user queries into vectors using the OpenAI embedding API.
 
-![Screenshot of chat app with question about climbing gear](docs/screenshot_chat.png)
+![Screenshot of chat app with question about climbing gear](docs/images/screenshot_chat.png)
+
+## Architecture diagram
+
+The deployed app uses a user-assigned managed identity to authenticate to Azure services, and stores logs in Log Analytics.
+
+![Architecture diagram: Azure Container Apps, Azure Container Registry, Managed Identity, Azure OpenAI, Azure Database for PostgreSQL](docs/images/architecture.png)
 
 ## Getting started
 
@@ -98,7 +104,7 @@ Once you've opened the project in [Codespaces](#github-codespaces), [Dev Contain
     For GitHub Codespaces users, if the previous command fails, try:
 
    ```shell
-    azd auth login --use-device-code 
+    azd auth login --use-device-code
     ```
 
 2. Create a new azd environment:
@@ -111,7 +117,7 @@ Once you've opened the project in [Codespaces](#github-codespaces), [Dev Contain
 
 3. (Optional) If you would like to customize the deployment to [use existing Azure resources](docs/deploy_existing.md), you can set the values now.
 
-3. Provision the resources and deploy the code:
+4. Provision the resources and deploy the code:
 
     ```shell
     azd up
@@ -195,6 +201,7 @@ Additionally, we have added a [GitHub Action](https://github.com/microsoft/secur
 
 Further documentation is available in the `docs/` folder:
 
+* [Understanding the RAG flow](docs/rag_flow.md)
 * [Customizing the data](docs/customize_data.md)
 * [Deploying with existing resources](docs/deploy_existing.md)
 * [Monitoring with Azure Monitor](docs/monitoring.md)
@@ -204,5 +211,6 @@ Please post in the issue tracker with any questions or issues.
 
 ## Resources
 
+* [RAGHack livestream: Building RAG with PostgreSQL](https://www.youtube.com/watch?v=Dk65oQjYAfo)
 * [RAG chat with Azure AI Search + Python](https://github.com/Azure-Samples/azure-search-openai-demo/)
 * [Develop Python apps that use Azure AI services](https://learn.microsoft.com/azure/developer/python/azure-ai-for-python-developers)

docs/customize_data.md

@@ -1,4 +1,4 @@
-# Customizing the data
+# RAG on PostgreSQL: Customizing the data
 
 This guide shows you how to bring in a table with a different schema than the sample table.
 
@@ -30,6 +30,7 @@ If you don't yet have any embeddings in `seed_data.json`:
 
 ## Add the seed data to the database
 
+Now that you have the new table schema and `seed_data.json` populated with embeddings, you can add the seed data to the database:
 
     ```shell
     python src/backend/fastapi_app/setup_postgres_seeddata.py

docs/deploy_existing.md

@@ -1,9 +1,9 @@
-# Deploying with existing Azure resources
+# RAG on PostgreSQL: Deploying with existing Azure resources
 
 If you already have existing Azure resources, or if you want to specify the exact name of new Azure Resource, you can do so by setting `azd` environment values.
 You should set these values before running `azd up`. Once you've set them, return to the [deployment steps](../README.md#deployment).
 
-### Openai.com OpenAI account
+## Openai.com OpenAI account
 
 1. Run `azd env set DEPLOY_AZURE_OPENAI false`
 1. Run `azd env set OPENAI_CHAT_HOST openaicom`