Skip to content

.Net: docs: fix 20 broken sample links in GettingStartedWithAgents README - #14699

Open
leom1919 wants to merge 1 commit into
microsoft:mainfrom
leom1919:docs-agent-samples-readme-links
Open

leom1919 wants to merge 1 commit into
microsoft:mainfrom
leom1919:docs-agent-samples-readme-links

Conversation

@leom1919

Copy link
Copy Markdown

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 .Net - Update and Fixes for AzureAIAgent #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 (.Net - Update and Fixes for AzureAIAgent #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.

Copilot AI balanced review requested due to automatic review settings October 31, 2026 11:55
@leom1919
leom1919 requested a review from a team as a code owner October 31, 2026 11:55
@leom1919
leom1919 deployed to github-app-auth October 31, 2026 11:55 — with GitHub Actions Active
@semantic-kernel-automation semantic-kernel-automation Bot added .NET Issue or Pull requests regarding .NET code documentation labels Oct 31, 2026
@github-actions github-actions Bot changed the title docs: fix 20 broken sample links in GettingStartedWithAgents README .Net: docs: fix 20 broken sample links in GettingStartedWithAgents README Oct 31, 2026

Copilot AI left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

🟢 Approval recommended

No active review issues are reported for this documentation-only update to sample links and labels.

No open issues 🎉

What changed in this PR

This documentation-only PR repairs 20 sample links in the .NET Getting Started with Agents README, helping readers reach the current examples.

Changes:

  • Corrects relative paths for 18 Agent, OpenAI Assistant, and Azure AI Agent links.
  • Replaces the removed Azure AI Agent chat entry with the vision sample introduced in #12348, updating its title and description.
  • Updates two orchestration links and labels to match renamed files.
File Description
dotnet/​samples/​GettingStartedWithAgents/​README.md Repairs sample links and aligns affected labels and descriptions with current samples.

Review effort: Balanced

This branch was successfully deployed

1 active deployment
github-app-auth — 1756ed01 Deployed Oct 31, 2026 by leom1919 via add_label #29520
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

documentation .NET Issue or Pull requests regarding .NET code

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants