Skip to content

Commit d41312f

Browse files
authored
.Net: docs: fix 20 broken sample links in GettingStartedWithAgents README (#14699)
## Motivation The sample tables in `dotnet/samples/GettingStartedWithAgents/README.md` contain 20 broken links: 1. **18 links use a wrong path prefix** — they were written as `./dotnet/samples/GettingStartedWithAgents/...`, but the README itself already lives in `dotnet/samples/GettingStartedWithAgents/`, so the links resolve to a doubled path and 404 on GitHub. The BedrockAgent, CopilotStudioAgent and Orchestration sections in the same file use correct relative paths (e.g. `./BedrockAgent/...`), which makes the inconsistency clear. 2. **2 links point to renamed files** in the `Orchestration/` folder: `Step02a_Sequential.cs` is now `Step02a_SequentialCancellation.cs` and `Step04b_HandoffWithStructuredInput.cs` is now `Step04a_HandoffWithStructuredInput.cs`. 3. **1 entry points to a removed sample**: `Step03_AzureAIAgent_Chat.cs` was removed and replaced by `Step03_AzureAIAgent_Vision.cs` in #12348 (both changes in the same commit), but the README row was never updated. ## Changes All in `dotnet/samples/GettingStartedWithAgents/README.md` (20 lines): - Agent section (7 links): strip the wrong `./dotnet/samples/GettingStartedWithAgents/` prefix. - OpenAIAssistant section (5 links): same prefix fix. - AzureAIAgent section (6 links): same prefix fix; additionally the Step03 row now points to `./AzureAIAgent/Step03_AzureAIAgent_Vision.cs` with its title and description updated to match the replacement sample. - Orchestration section (2 links): update to the renamed `Step02a_SequentialCancellation.cs` and `Step04a_HandoffWithStructuredInput.cs`. ## Verification - Every new link target was verified to exist on the current `main` tree (file listing of `dotnet/samples/GettingStartedWithAgents/`, `OpenAIAssistant/`, `AzureAIAgent/`, `Orchestration/`). - The removal of `Step03_AzureAIAgent_Chat.cs` and addition of `Step03_AzureAIAgent_Vision.cs` were confirmed via the commit history of the `AzureAIAgent` folder (#12348); the new description mirrors the wording of the OpenAIAssistant Vision row. - No text outside the affected table rows was modified. > [!NOTE] > This documentation fix was prepared with AI assistance (an automated contribution workflow). Happy to adjust anything — e.g. if you prefer keeping the old `Step03_AzureAIAgent_Chat` row title or handling it differently.
1 parent d5b2a41 commit d41312f

1 file changed

Lines changed: 20 additions & 20 deletions

File tree

  • dotnet/samples/GettingStartedWithAgents

‎dotnet/samples/GettingStartedWithAgents/README.md‎

Lines changed: 20 additions & 20 deletions
Original file line numberDiff line numberDiff line change
@@ -22,34 +22,34 @@ The getting started with agents examples include:
2222

2323
Example|Description
2424
---|---
25-
[Step01_Agent](./dotnet/samples/GettingStartedWithAgents/Step01_Agent.cs)|How to create and use an agent.
26-
[Step02_Plugins](./dotnet/samples/GettingStartedWithAgents/Step02_Plugins.cs)|How to associate plug-ins with an agent.
27-
[Step03_Chat](./dotnet/samples/GettingStartedWithAgents/Step03_Chat.cs)|How to create a conversation between agents.
28-
[Step04_KernelFunctionStrategies](./dotnet/samples/GettingStartedWithAgents/Step04_KernelFunctionStrategies.cs)|How to utilize a `KernelFunction` as a _chat strategy_.
29-
[Step05_JsonResult](./dotnet/samples/GettingStartedWithAgents/Step05_JsonResult.cs)|How to have an agent produce JSON.
30-
[Step06_DependencyInjection](./dotnet/samples/GettingStartedWithAgents/Step06_DependencyInjection.cs)|How to define dependency injection patterns for agents.
31-
[Step07_Telemetry](./dotnet/samples/GettingStartedWithAgents/Step07_Telemetry.cs)|How to enable logging for agents.
25+
[Step01_Agent](./Step01_Agent.cs)|How to create and use an agent.
26+
[Step02_Plugins](./Step02_Plugins.cs)|How to associate plug-ins with an agent.
27+
[Step03_Chat](./Step03_Chat.cs)|How to create a conversation between agents.
28+
[Step04_KernelFunctionStrategies](./Step04_KernelFunctionStrategies.cs)|How to utilize a `KernelFunction` as a _chat strategy_.
29+
[Step05_JsonResult](./Step05_JsonResult.cs)|How to have an agent produce JSON.
30+
[Step06_DependencyInjection](./Step06_DependencyInjection.cs)|How to define dependency injection patterns for agents.
31+
[Step07_Telemetry](./Step07_Telemetry.cs)|How to enable logging for agents.
3232

3333
### Open AI Assistant
3434

3535
Example|Description
3636
---|---
37-
[Step01_Assistant](./dotnet/samples/GettingStartedWithAgents/OpenAIAssistant/Step01_Assistant.cs)|How to create an Open AI Assistant agent.
38-
[Step02_Assistant_Plugins](./dotnet/samples/GettingStartedWithAgents/OpenAIAssistant/Step02_Assistant_Plugins.cs)|How to associate plug-ins with an Open AI Assistant agent.
39-
[Step03_Assistant_Vision](./dotnet/samples/GettingStartedWithAgents/OpenAIAssistant/Step03_Assistant_Vision.cs)|How to provide an image as input to an Open AI Assistant agent.
40-
[Step04_AssistantTool_CodeInterpreter_](./dotnet/samples/GettingStartedWithAgents/OpenAIAssistant/Step04_AssistantTool_CodeInterpreter.cs)|How to use the code-interpreter tool for an Open AI Assistant agent.
41-
[Step05_AssistantTool_FileSearch](./dotnet/samples/GettingStartedWithAgents/OpenAIAssistant/Step05_AssistantTool_FileSearch.cs)|How to use the file-search tool for an Open AI Assistant agent.
37+
[Step01_Assistant](./OpenAIAssistant/Step01_Assistant.cs)|How to create an Open AI Assistant agent.
38+
[Step02_Assistant_Plugins](./OpenAIAssistant/Step02_Assistant_Plugins.cs)|How to associate plug-ins with an Open AI Assistant agent.
39+
[Step03_Assistant_Vision](./OpenAIAssistant/Step03_Assistant_Vision.cs)|How to provide an image as input to an Open AI Assistant agent.
40+
[Step04_AssistantTool_CodeInterpreter_](./OpenAIAssistant/Step04_AssistantTool_CodeInterpreter.cs)|How to use the code-interpreter tool for an Open AI Assistant agent.
41+
[Step05_AssistantTool_FileSearch](./OpenAIAssistant/Step05_AssistantTool_FileSearch.cs)|How to use the file-search tool for an Open AI Assistant agent.
4242

4343
### Azure AI Agent
4444

4545
Example|Description
4646
---|---
47-
[Step01_AzureAIAgent](./dotnet/samples/GettingStartedWithAgents/AzureAIAgent/Step01_AzureAIAgent.cs)|How to create an `AzureAIAgent`.
48-
[Step02_AzureAIAgent_Plugins](./dotnet/samples/GettingStartedWithAgents/AzureAIAgent/Step02_AzureAIAgent_Plugins.cs)|How to associate plug-ins with an `AzureAIAgent`.
49-
[Step03_AzureAIAgent_Chat](./dotnet/samples/GettingStartedWithAgents/AzureAIAgent/Step03_AzureAIAgent_Chat.cs)|How create a conversation with `AzureAIAgent`s.
50-
[Step04_AzureAIAgent_CodeInterpreter](./dotnet/samples/GettingStartedWithAgents/AzureAIAgent/Step04_AzureAIAgent_CodeInterpreter.cs)|How to use the code-interpreter tool for an `AzureAIAgent`.
51-
[Step05_AzureAIAgent_FileSearch](./dotnet/samples/GettingStartedWithAgents/AzureAIAgent/Step05_AzureAIAgent_FileSearch.cs)|How to use the file-search tool for an `AzureAIAgent`.
52-
[Step06_AzureAIAgent_OpenAPI](./dotnet/samples/GettingStartedWithAgents/AzureAIAgent/Step06_AzureAIAgent_OpenAPI.cs)|How to use the Open API tool for an `AzureAIAgent`.
47+
[Step01_AzureAIAgent](./AzureAIAgent/Step01_AzureAIAgent.cs)|How to create an `AzureAIAgent`.
48+
[Step02_AzureAIAgent_Plugins](./AzureAIAgent/Step02_AzureAIAgent_Plugins.cs)|How to associate plug-ins with an `AzureAIAgent`.
49+
[Step03_AzureAIAgent_Vision](./AzureAIAgent/Step03_AzureAIAgent_Vision.cs)|How to provide an image as input to an `AzureAIAgent`.
50+
[Step04_AzureAIAgent_CodeInterpreter](./AzureAIAgent/Step04_AzureAIAgent_CodeInterpreter.cs)|How to use the code-interpreter tool for an `AzureAIAgent`.
51+
[Step05_AzureAIAgent_FileSearch](./AzureAIAgent/Step05_AzureAIAgent_FileSearch.cs)|How to use the file-search tool for an `AzureAIAgent`.
52+
[Step06_AzureAIAgent_OpenAPI](./AzureAIAgent/Step06_AzureAIAgent_OpenAPI.cs)|How to use the Open API tool for an `AzureAIAgent`.
5353

5454
### Bedrock Agent
5555

@@ -77,12 +77,12 @@ Example|Description
7777
[Step01_Concurrent](./Orchestration/Step01_Concurrent.cs)|How to use a concurrent orchestration..
7878
[Step01a_ConcurrentWithStructuredOutput](./Orchestration/Step01a_ConcurrentWithStructuredOutput.cs)|How to use structured output (with concurrent orchestration).
7979
[Step02_Sequential](./Orchestration/Step02_Sequential.cs)|How to use sequential orchestration.
80-
[Step02a_Sequential](./Orchestration/Step02a_Sequential.cs)|How to cancel an orchestration (with sequential orchestration).
80+
[Step02a_SequentialCancellation](./Orchestration/Step02a_SequentialCancellation.cs)|How to cancel an orchestration (with sequential orchestration).
8181
[Step03_GroupChat](./Orchestration/Step03_GroupChat.cs)|How to use group-chat orchestration.
8282
[Step03a_GroupChatWithHumanInTheLoop](./Orchestration/Step03a_GroupChatWithHumanInTheLoop.cs)|How to use group-chat orchestration with human in the loop.
8383
[Step03b_GroupChatWithAIManager](./Orchestration/Step03b_GroupChatWithAIManager.cs)|How to use group-chat orchestration with a AI powered group-manager.
8484
[Step04_Handoff](./Orchestration/Step04_Handoff.cs)|How to use handoff orchestration.
85-
[Step04b_HandoffWithStructuredInput](./Orchestration/Step04b_HandoffWithStructuredInput.cs)|How to use structured input (with handoff orchestration).
85+
[Step04a_HandoffWithStructuredInput](./Orchestration/Step04a_HandoffWithStructuredInput.cs)|How to use structured input (with handoff orchestration).
8686

8787
## Legacy Agents
8888

0 commit comments

Comments
 (0)