docs(examples): standardize prerequisites section and improve clarity #381
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.
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 - documentationMotivation 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
Screenshots
Checklist
mkdocs serveAdditional Notes
By submitting this pull request, I confirm that you can use, modify, copy, and redistribute this contribution, under the terms of your choice.