Skip to content

Fix Strands Agents documentation links in ADR - #4584

Merged
SergeyMenshykh merged 5 commits into
mainfrom
copilot/fix-broken-links-in-docs
Mar 10, 2026
Merged

Fix Strands Agents documentation links in ADR#4584
SergeyMenshykh merged 5 commits into
mainfrom
copilot/fix-broken-links-in-docs

Conversation

CopilotAI commented Mar 10, 2026

Copy link
Copy Markdown
Contributor

Motivation and Context

Strands Agents links in the agent-run-response ADR pointed to generic API reference pages or GitHub source. Reviewer feedback requested specific documentation URLs for streaming, structured output, and AgentResult, plus deduplication of an identical link used twice in the stop-reason row.

Description

Updated Strands Agents links in docs/decisions/0001-agent-run-response.md:

Contribution Checklist

  • The code builds clean without any errors or warnings
  • The PR follows the Contribution Guidelines
  • All unit tests pass, and I have added new tests where possible
  • Is this a breaking change? If yes, add "[BREAKING]" prefix to the title of the PR.

🔒 GitHub Advanced Security automatically protects Copilot coding agent pull requests. You can protect all pull requests by enabling Advanced Security for your repositories. Learn more about Advanced Security.

Replace 5 broken strandsagents.com URLs (returning 404) with stable
GitHub source code links in docs/decisions/0001-agent-run-response.md.
The Strands Agents docs site restructured from /api-reference/python/
to /api/python/, breaking the old links.
Co-authored-by: SergeyMenshykh <68852919+SergeyMenshykh@users.noreply.github.com>
CopilotAI changed the title [WIP] Fix broken links in decisions documentationFix broken Strands Agents documentation links in ADR 0001Mar 10, 2026
Replace GitHub source links with official strandsagents.com/docs/api/python/
documentation URLs in docs/decisions/0001-agent-run-response.md.
Co-authored-by: SergeyMenshykh <68852919+SergeyMenshykh@users.noreply.github.com>
- Streaming: strandsagents.com/docs/user-guide/concepts/streaming/
- Structured output: strandsagents.com/docs/user-guide/concepts/agents/structured-output/
- AgentResult/stop_reason: strandsagents.com/docs/api/python/strands.agent.agent_result/#agentresult
Co-authored-by: SergeyMenshykh <68852919+SergeyMenshykh@users.noreply.github.com>
CopilotAI changed the title Fix broken Strands Agents documentation links in ADR 0001Update Strands Agents links to use official documentation siteMar 10, 2026
Replaced the duplicate hyperlink on `stop_reason` with inline code,
keeping a single AgentResult link to the same URL.
Co-authored-by: SergeyMenshykh <68852919+SergeyMenshykh@users.noreply.github.com>
CopilotAI changed the title Update Strands Agents links to use official documentation siteFix Strands Agents documentation links in ADRMar 10, 2026
@SergeyMenshykh
SergeyMenshykh marked this pull request as ready for review March 10, 2026 14:52
CopilotAI review requested due to automatic review settings March 10, 2026 14:52
@markwallace-microsoftMark Wallace (markwallace-microsoft) added the documentation Usage: [Issues, PRs], Target: documentation in the code base and learn docs label Mar 10, 2026
@SergeyMenshykhSergeyMenshykh moved this to In Review in Agent FrameworkMar 10, 2026

CopilotAI 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.

Pull request overview

Updates the Agent Run Responses ADR to point AWS (Strands) references at specific, user-facing Strands Agents documentation pages instead of generic API refs/source links, improving the usefulness of the comparison tables.

Changes:

  • Updated the Strands streaming link to the Strands “Streaming” concept documentation page.
  • Updated the Strands structured output link to the Strands “Structured output” concept documentation page.
  • Updated AgentResult links to use the newer docs path and include an #agentresult anchor.

Comment threaddocs/decisions/0001-agent-run-response.md
@SergeyMenshykh
SergeyMenshykh added this pull request to the merge queueMar 10, 2026
Merged via the queue into main with commit fbcf144Mar 10, 2026
22 checks passed
Sign up for freeto join this conversation on GitHub. Already have an account? Sign in to comment

Labels

documentationUsage: [Issues, PRs], Target: documentation in the code base and learn docs

Projects

Status: Done

Development

Successfully merging this pull request may close these issues.

6 participants

@eavanvalkenburg@rogerbarreto@SergeyMenshykh@markwallace-microsoft