Skip to content

Conversation

@azarboon
Copy link
Contributor

Description

This update makes the prerequisites section for examples clearer and standardized. This new PR incorporates suggestions from @lizradway in this comment.

Type of Change

  • New content addition
  • Content update/revision
  • Structure/organization improvement
  • Typo/formatting fix
  • Bug fix
  • Other (please describe):
Content update - documentation

Motivation and Context

The cli-reference-agent example stood out among the examples because its prerequisites section was repetitive and omitted pipx. I have corrected this by adding the missing prerequisite, removing duplicates, and making the prerequisites section more coherent across both this example and its parent page.

Additionally, the requirement for access to the Claude 4 model to run examples was fragmented in the documentation. I have clarified this, as I personally encountered errors when starting with Strands due to lack of access. This change improves clarity and makes onboarding smoother for new users.

Overall, this update enhances readability and navigation of the documentation.

This PR incorporates suggestions from @lizradway in this comment.

Areas Affected

  • docs/examples/README.md
  • docs/examples/python/cli-reference-agent.md
  • docs/user-guide/quickstart.md
  • docs/user-guide/quickstart/python.md

Screenshots

Checklist

  • I have read the CONTRIBUTING document
  • My changes follow the project's documentation style
  • I have tested the documentation locally using mkdocs serve
  • Links in the documentation are valid and working
  • Images/diagrams are properly sized and formatted
  • All new and existing tests pass

Additional Notes

By submitting this pull request, I confirm that you can use, modify, copy, and redistribute this contribution, under the terms of your choice.

Copy link
Member

@cagataycali cagataycali left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Review Summary

This PR standardizes the prerequisites section across example documentation and improves clarity for new users. This addresses real onboarding friction points.

✅ What's Good

  • User-focused improvement - Author personally encountered errors due to unclear prerequisites, so this fixes a real pain point
  • Consistency - Standardizes prerequisites across multiple pages (examples/README.md, cli-reference-agent.md, quickstart pages)
  • Incorporates feedback - Addresses suggestions from @lizradway in a previous review
  • Small, focused changes - 10 additions, 8 deletions across 4 files

📝 Changes Summary

  • docs/examples/README.md - Added pipx mention
  • docs/examples/python/cli-reference-agent.md - Removed duplicate prereqs, improved coherence
  • docs/user-guide/quickstart.md - Clarified Claude 4 model access requirement
  • docs/user-guide/quickstart/python.md - Same Claude 4 clarification

💡 Value Add

Clarifying the Claude 4 model access requirement upfront will prevent new users from hitting confusing errors - this is a high-value documentation improvement.

Status

  • Mergeable: ✅ Yes
  • Conflicts: None

Recommend merging - This is a quality-of-life improvement for documentation that addresses real user friction.


Review by strands-coder autonomous agent 🤖

@azarboon
Copy link
Contributor Author

Thank you, @cagataycali for the review. I’m quite new to making merges in this repository. May I ask what the next step is?

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants