From e10c44a7d1568a35d1b1fac2d76efb61845b6ee1 Mon Sep 17 00:00:00 2001
From: Steven Bucher <stevenbucher8@gmail.com>
Date: Wed, 15 Jan 2025 09:13:56 -0800
Subject: [PATCH] Modifying readme and agent to point to docs

---
 README.md                                   | 4 ++++
 shell/agents/AIShell.OpenAI.Agent/Agent.cs  | 2 ++
 shell/agents/AIShell.OpenAI.Agent/README.md | 2 +-
 3 files changed, 7 insertions(+), 1 deletion(-)

diff --git a/README.md b/README.md
index 32460368..8283d9d3 100644
--- a/README.md
+++ b/README.md
@@ -77,6 +77,10 @@ README in the each agent folder.
 
 To learn more about how to create an agent for yourself please see, [Creating an Agent][03].
 
+In order to use the `openai-gpt` agent you will need a valid Azure OpenAI service or a public OpenAI
+key. For more information on how to get an Azure OpenAI service, see
+[Deploying Azure OpenAI Service](./docs/development/AzureOAIDeployment/DeployingAzureOAI.md).
+
 ### Chat commands
 
 By default, `aish` provides a base set of chat `/` commands used to interact with the responses from
diff --git a/shell/agents/AIShell.OpenAI.Agent/Agent.cs b/shell/agents/AIShell.OpenAI.Agent/Agent.cs
index 16a86d4e..f9a8ba05 100644
--- a/shell/agents/AIShell.OpenAI.Agent/Agent.cs
+++ b/shell/agents/AIShell.OpenAI.Agent/Agent.cs
@@ -151,6 +151,8 @@ 1. Run '/agent config' to open the setting file.
             2. {1}. See details at
                  https://aka.ms/aish/openai
             3. Run '/refresh' to apply the new settings.
+
+            If you would like to learn more about deploying your own Azure OpenAI Service please see https://aka.ms/AIShell/DeployAOAI.
             """;
 
         if (_settings is null || _settings.GPTs.Count is 0)
diff --git a/shell/agents/AIShell.OpenAI.Agent/README.md b/shell/agents/AIShell.OpenAI.Agent/README.md
index e88bb2e6..fecb5ce7 100644
--- a/shell/agents/AIShell.OpenAI.Agent/README.md
+++ b/shell/agents/AIShell.OpenAI.Agent/README.md
@@ -2,7 +2,7 @@
 
 This agent is designed to provide a flexible and user-friendly platform for interacting with OpenAI
 services, either the public OpenAI service or a private deployment of the Azure OpenAI service,
-through one or more customly defined GPT instances.
+through one or more custom defined GPT instances.
 
 For more information about this agent, see the [OpenAI Agent][01] documentation.