From e4f0d156ab60e61cce651fe8f244767248d6a66c Mon Sep 17 00:00:00 2001 From: mahdi Date: Thu, 18 Dec 2025 08:40:24 +0800 Subject: [PATCH] make the flow in documentation smooth --- docs/examples/README.md | 4 ++++ docs/examples/python/cli-reference-agent.md | 10 ++++------ docs/user-guide/quickstart.md | 2 +- docs/user-guide/quickstart/python.md | 2 +- 4 files changed, 10 insertions(+), 8 deletions(-) diff --git a/docs/examples/README.md b/docs/examples/README.md index bf2403da..14bbfbe0 100644 --- a/docs/examples/README.md +++ b/docs/examples/README.md @@ -11,8 +11,12 @@ By exploring these reference implementations, you'll gain practical insights int ## Prerequisites - Python 3.10 or higher +- Strands Agents SDK +- AWS credentials configured with access to a Bedrock model provider using the Claude 4 model (modifiable as needed) - For specific examples, additional requirements may be needed (see individual example READMEs) +For more information, see the [Getting Started](../user-guide/quickstart.md) guide. + ## Getting Started 1. Clone the repository containing these examples diff --git a/docs/examples/python/cli-reference-agent.md b/docs/examples/python/cli-reference-agent.md index 4225f50e..50a5f3ad 100644 --- a/docs/examples/python/cli-reference-agent.md +++ b/docs/examples/python/cli-reference-agent.md @@ -6,13 +6,11 @@ The Strands CLI is Open-Source and available [strands-agents/agent-builder](http ## Prerequisites -Before installing the Strands CLI, ensure you have: +In addition to the prerequisites listed for [examples](../README.md), this example requires the following: -- Python 3.10 or higher -- pip (Python package installer) -- git -- AWS account with Bedrock access (for using Bedrock models) -- AWS credentials configured (for AWS integrations) +- Python package installer (`pip`) +- [pipx](https://github.com/pypa/pipx) for isolated Python package installation +- Git ## Standard Installation diff --git a/docs/user-guide/quickstart.md b/docs/user-guide/quickstart.md index 1e2a0218..00a468b8 100644 --- a/docs/user-guide/quickstart.md +++ b/docs/user-guide/quickstart.md @@ -61,7 +61,7 @@ See the [MCP server documentation](https://github.com/strands-agents/mcp-server) ## Configuring Credentials -Strands supports many different model providers. By default, agents use the Amazon Bedrock model provider with the Claude 4 model. +Strands supports many different model providers. By default, agents use the Amazon Bedrock model provider with the Claude 4 model. To change the default model, refer to [the Model Providers section](./quickstart/python.md#model-providers). To use the examples in this guide, you'll need to configure your environment with AWS credentials that have permissions to invoke the Claude 4 model. You can set up your credentials in several ways: diff --git a/docs/user-guide/quickstart/python.md b/docs/user-guide/quickstart/python.md index da58a61d..55754de5 100644 --- a/docs/user-guide/quickstart/python.md +++ b/docs/user-guide/quickstart/python.md @@ -61,7 +61,7 @@ See the [MCP server documentation](https://github.com/strands-agents/mcp-server) ## Configuring Credentials -Strands supports many different model providers. By default, agents use the Amazon Bedrock model provider with the Claude 4 model. +Strands supports many different model providers. By default, agents use the Amazon Bedrock model provider with the Claude 4 model. To modify the default model, refer to [the Model Providers section](#model-providers) To use the examples in this guide, you'll need to configure your environment with AWS credentials that have permissions to invoke the Claude 4 model. You can set up your credentials in several ways: