Python: Fix broken links and anchors in sample READMEs - #14377
Open
陈志谦 (simpleqt) wants to merge 1 commit into
Open
Python: Fix broken links and anchors in sample READMEs#14377陈志谦 (simpleqt) wants to merge 1 commit into
陈志谦 (simpleqt) wants to merge 1 commit into
Conversation
- agent samples index: two step filenames had drifted from the actual files (structure_output -> structured_outputs, structure_input -> structured_inputs) - azure_ai_agent README: linked step7_... file is step07_... on disk - multi_agent_orchestration README: concepts/structured_output/ dir is structured_outputs/ - concepts README: bing_text_search_as_plugin.py sample no longer exists (drop the bullet); the Search heading linked to the removed connectors/search directory, now the connectors/search.py module - CONFIGURING_THE_KERNEL.md: Entra auth anchor renamed, the section is now 'Azure Authentication'
Contributor
There was a problem hiding this comment.
🟢 Approval recommended
The changes are documentation-only and the updated links/targets correspond to paths and headings that exist in the repo.
Pull request overview
This PR updates Python sample documentation to repair broken relative links and heading anchors in several sample READMEs/markdown guides, ensuring navigation within python/samples points to files and sections that actually exist.
Changes:
- Fixes sample links to renamed/zero-padded agent orchestration scripts (
step1a_*,step4a_*,step07_*). - Updates a concept link from
structured_output/to the correctstructured_outputs/directory. - Cleans up the Concepts index by removing a non-existent Bing sample entry and repointing the Search connector reference to
connectors/search.py. - Corrects a README anchor reference to match the actual “Azure Authentication” heading.
File summaries
| File | Description |
|---|---|
| python/samples/getting_started/CONFIGURING_THE_KERNEL.md | Updates the concepts README anchor link to the correct “Azure Authentication” section. |
| python/samples/getting_started_with_agents/README.md | Fixes broken sample links to the correct structured outputs/inputs filenames. |
| python/samples/getting_started_with_agents/multi_agent_orchestration/README.md | Corrects the Structured Output concept link to the existing structured_outputs directory. |
| python/samples/getting_started_with_agents/azure_ai_agent/README.md | Fixes the retrieval sample link to the correctly named step07_... file. |
| python/samples/concepts/README.md | Removes a stale Bing sample bullet and updates the Search connector link target. |
Review details
- Files reviewed: 5/5 changed files
- Comments generated: 0
- Review effort level: Lite
💡 Add a code-review agent skill or configure MCP servers for context-aware, tailored reviews. Learn more in the docs.
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Fixes six broken relative links/anchors across the python sample READMEs (each verified against
git ls-files/ actual headings;python/samplesis excluded from linkspector, which is why CI never caught them):getting_started_with_agents/README.md:step1a_concurrent_structure_output.py→step1a_concurrent_structured_outputs.py,step4a_handoff_structure_input.py→step4a_handoff_structured_inputs.pygetting_started_with_agents/azure_ai_agent/README.md:./step7_azure_ai_agent_retrieval.py→./step07_azure_ai_agent_retrieval.pygetting_started_with_agents/multi_agent_orchestration/README.md:../../concepts/structured_output/→structured_outputs/concepts/README.md: dropped the Bing bullet (search/bing_text_search_as_plugin.pyno longer exists) and repointed the Search heading from the removedconnectors/searchtree toconnectors/search.pygetting_started/CONFIGURING_THE_KERNEL.md: anchor#microsoft-entra-token-authentication→#azure-authentication(actual heading)Contribution checklist: