Skip to content

Python: Docs: fix 9 dead external links across samples, demos and ADR - #14691

Open
leom1919 wants to merge 1 commit into
microsoft:mainfrom
leom1919:docs-fix-dead-links-2026-10-30
Open

leom1919 wants to merge 1 commit into
microsoft:mainfrom
leom1919:docs-fix-dead-links-2026-10-30

Conversation

@leom1919

Copy link
Copy Markdown

Description

Routine external-link audit found 9 dead links across 6 files. Every old target was verified dead (HTTP 404, or the sample/directory removed upstream) and every replacement was verified live (HTTP 200) at submission time. All fixes are link-only; no code or prose meaning changed.

File Old (dead) New (live) Note
dotnet/samples/Demos/VoiceChat/README.md developers.deepgram.com/docs/streaming developers.deepgram.com/docs/live-streaming-audio Deepgram docs restructure; current page verified in their sitemap
dotnet/samples/Demos/VoiceChat/README.md assemblyai.com/docs/real-time-speech-recognition assemblyai.com/docs/streaming AssemblyAI docs restructure; sitemap-verified
dotnet/samples/Demos/A2AClientServer/README.md google.github.io/A2A a2a-protocol.org/latest/ A2A project moved off google.github.io; official site today
python/samples/concepts/mcp/README.md modelcontextprotocol/servers/tree/main/src/github github/github-mcp-server The GitHub reference server was removed from modelcontextprotocol/servers; github/github-mcp-server is the official successor with PAT documentation
dotnet/samples/Demos/ModelContextProtocolClientServer/README.md csharp-sdk samples/AspNetCoreSseServer csharp-sdk samples/AspNetCoreMcpServer Sample renamed upstream; link text updated to match
dotnet/samples/Demos/ModelContextProtocolPluginAuth/README.md (x2) csharp-sdk samples/ProtectedMCPClient csharp-sdk samples/ProtectedMcpClient Path is case-sensitive on github.com; anchors verified against the sample's README headings
docs/decisions/0067-hybrid-search.md docs.pinecone.io/guides/get-started/key-features#hybrid-search docs.pinecone.io/guides/search/hybrid-search Page moved; current hybrid-search guide
docs/decisions/0067-hybrid-search.md elastic.github.io/elasticsearch-net/8.16.3/api/...TextProperty.html elastic.co/guide/en/elasticsearch/reference/current/text.html The generated API-docs tree was removed from the elasticsearch-net docs site (all versions 404); replaced with the stable Elastic reference page for the text field type

Motivation

These links are the first entry point for users trying to run the VoiceChat, A2A, and MCP samples, or evaluating vector stores via ADR-0067; each currently dead-ends.

Verification

  • Old URLs: curl -I -L (browser user-agent) returned 404 for all; the two GitHub paths were additionally confirmed against the upstream repos' Contents API (samples/AspNetCoreSseServer and src/github no longer exist; ProtectedMcpClient exists only with that casing).
  • New URLs: all verified HTTP 200 with a browser user-agent; Deepgram and AssemblyAI pages confirmed present in their sites' sitemaps; github/github-mcp-server confirmed via API.
  • No functional changes; markdown-only.

This contribution was AI-assisted; all old and new URLs were checked programmatically during the audit.

Routine external-link audit found 9 dead links across 6 files. Every old target was verified dead (HTTP 404, or sample removed upstream) and every replacement verified live (HTTP 200) at submission time.

Replacements:
- Deepgram streaming docs: /docs/streaming -> /docs/live-streaming-audio (sitemap-verified current page)
- AssemblyAI streaming docs: /docs/real-time-speech-recognition -> /docs/streaming (sitemap-verified)
- A2A protocol: google.github.io/A2A (404) -> a2a-protocol.org/latest/ (project's current official site)
- GitHub MCP Server: modelcontextprotocol/servers/src/github (removed upstream) -> github/github-mcp-server (official successor)
- csharp-sdk samples: AspNetCoreSseServer (renamed) -> AspNetCoreMcpServer; ProtectedMCPClient -> ProtectedMcpClient (exact path casing)
- Pinecone hybrid search: /guides/get-started/key-features#hybrid-search (404) -> /guides/search/hybrid-search
- Elastic .NET API docs page (whole /api/ tree removed from elasticsearch-net docs site) -> Elastic reference docs for the text field type

This contribution was AI-assisted; all old and new URLs were checked programmatically.
Copilot AI balanced review requested due to automatic review settings October 30, 2026 13:19
@leom1919
leom1919 deployed to github-app-auth October 30, 2026 13:19 — with GitHub Actions Active
@leom1919
leom1919 requested review from a team as code owners October 30, 2026 13:20
@semantic-kernel-automation semantic-kernel-automation Bot added .NET Issue or Pull requests regarding .NET code python Pull requests for the Python Semantic Kernel documentation labels Oct 30, 2026
@github-actions github-actions Bot changed the title Docs: fix 9 dead external links across samples, demos and ADR .Net: Docs: fix 9 dead external links across samples, demos and ADR Oct 30, 2026
@github-actions github-actions Bot changed the title Docs: fix 9 dead external links across samples, demos and ADR Python: Docs: fix 9 dead external links across samples, demos and ADR Oct 30, 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 these documentation link updates.

No open issues 🎉

What changed in this PR

Updates nine external links across Semantic Kernel sample documentation and the hybrid-search architecture decision record. Changes are limited to Markdown URLs and one sample link label; runtime behavior is unchanged.

Changes:

  • Refresh speech-service, A2A protocol, and GitHub MCP server documentation links.
  • Correct renamed MCP C# SDK sample paths and path casing.
  • Update Pinecone hybrid-search and Elasticsearch text-field references.
File Description
python/​samples/​concepts/​mcp/​README.md Points authentication guidance to the official GitHub MCP server.
dotnet/​samples/​Demos/​VoiceChat/​README.md Updates Deepgram and AssemblyAI streaming documentation links.
dotnet/​samples/​Demos/​ModelContextProtocolPluginAuth/​README.md Corrects casing in two protected-client sample links.
dotnet/​samples/​Demos/​ModelContextProtocolClientServer/​README.md Updates the remote-server sample URL and link label.
dotnet/​samples/​Demos/​A2AClientServer/​README.md Links to the current A2A protocol site.
docs/​decisions/​0067-hybrid-search.md Refreshes Pinecone and Elasticsearch documentation references.

Review effort: Balanced

This branch was successfully deployed

1 active deployment
github-app-auth — f5ac1724 Deployed Oct 30, 2026 by leom1919 via add_label #29506
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 python Pull requests for the Python Semantic Kernel

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants