Skip to content

fix: convert metrics output section to collapsible details/summary#699

Merged
zastrowm merged 3 commits intomainfrom
agent-tasks/698
Mar 24, 2026
Merged

fix: convert metrics output section to collapsible details/summary#699
zastrowm merged 3 commits intomainfrom
agent-tasks/698

Conversation

@zastrowm
Copy link
Copy Markdown
Member

@zastrowm zastrowm commented Mar 24, 2026

Summary

Converts the inline :::note[...] block in the quickstart guide's "Understanding What Agents Did" section to a collapsible <details>/<summary> HTML pattern.

Changes

Replaced the Starlight Aside component with HTML collapsible section:

Before:

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

:::note[Example result.metrics.get_summary() output]
...code blocks...
:::

After:

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

<details>
  <summary>
    <strong>Example result.metrics.get_summary() output</strong>
  </summary>

  ...code blocks...
</details>

Why

  • Reduces visual clutter on the quickstart page
  • Allows users to expand detailed output only when needed
  • Follows existing documentation patterns used in deploy_to_docker/python.mdx and deploy_to_terraform.mdx

Resolves #698

Replace the inline :::note[...] block in the Understanding What Agents
Did section with a <details>/<summary> HTML pattern to reduce visual
clutter and allow users to expand the detailed output only when needed.

Follows the existing collapsible pattern used in deploy_to_docker/python.mdx
and deploy_to_terraform.mdx.

Resolves #698
@zastrowm

This comment has been minimized.

Remove temporary log files that were accidentally included in the previous commit.
@github-actions

This comment has been minimized.

@github-actions

This comment was marked as outdated.

@github-actions
Copy link
Copy Markdown
Contributor

Assessment: Approve

Clean change that converts the metrics example from an always-visible :::note block to a collapsible <details>/<summary> element. This follows existing patterns in the repo (e.g., deploy_to_docker/python.mdx, deploy_to_terraform.mdx) and improves readability on the quickstart page.

LGTM! 👍

@github-actions
Copy link
Copy Markdown
Contributor

Documentation Preview Ready

Your documentation preview has been successfully deployed!

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

Updated at: 2026-03-24T14:17:27.687Z

@zastrowm zastrowm marked this pull request as ready for review March 24, 2026 14:19
@zastrowm zastrowm added the agent label Mar 24, 2026
@zastrowm zastrowm enabled auto-merge (squash) March 24, 2026 14:23
@zastrowm zastrowm merged commit 7c1b466 into main Mar 24, 2026
7 checks passed
notowen333 pushed a commit to notowen333/docs that referenced this pull request Mar 27, 2026
…trands-agents#699)

Co-authored-by: Strands Agent <217235299+strands-agent@users.noreply.github.com>
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.

BUG: Understanding What Agents Did section should use collapsable section

3 participants