Skip to content

docs: wrap quickstart metrics output in collapsible section#2550

Merged
zastrowm merged 1 commit into
strands-agents:mainfrom
zastrowm:metric-output
Jun 2, 2026
Merged

docs: wrap quickstart metrics output in collapsible section#2550
zastrowm merged 1 commit into
strands-agents:mainfrom
zastrowm:metric-output

Conversation

@zastrowm
Copy link
Copy Markdown
Member

@zastrowm zastrowm commented Jun 1, 2026

Summary

  • Wraps the large result.metrics.get_summary() JSON output in a <details> collapsible inside the existing :::note admonition on the Python quickstart page
  • Reduces visual noise on page load while keeping the example accessible
  • Fixes the output code fence language from python to json

Verification

Compare

https://d3ehv1nix5p99z.cloudfront.net/pr-cms-2550/docs/user-guide/quickstart/python/#understanding-what-agents-did

to

https://strandsagents.com/docs/user-guide/quickstart/python/#understanding-what-agents-did

The full get_summary() JSON blob dominates the quickstart page. Wrap it
in a <details> element so it's collapsed by default while keeping the
surrounding :::note admonition.
@zastrowm zastrowm temporarily deployed to manual-approval June 1, 2026 22:00 — with GitHub Actions Inactive
@zastrowm zastrowm marked this pull request as ready for review June 2, 2026 13:10
@github-actions
Copy link
Copy Markdown
Contributor

github-actions Bot commented Jun 2, 2026

Assessment: Approve

Clean, well-scoped change. The pythonjson code fence fix is correct, and wrapping 150+ lines of JSON output in a collapsible is a good UX improvement for the quickstart page.

@github-actions
Copy link
Copy Markdown
Contributor

github-actions Bot commented Jun 2, 2026

Documentation Preview Ready

Your documentation preview has been successfully deployed!

Preview URL: https://d3ehv1nix5p99z.cloudfront.net/pr-cms-2550/docs/user-guide/quickstart/overview/

Updated at: 2026-06-02T13:41:26.015Z

@zastrowm zastrowm enabled auto-merge (squash) June 2, 2026 13:51
@zastrowm zastrowm merged commit 37141f5 into strands-agents:main Jun 2, 2026
18 of 19 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants