Skip to content

docs(examples): standardize prerequisites section and improve clarity #381

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
azarboon wants to merge 1 commit into
base: main
Choose a base branch
from
Open

docs(examples): standardize prerequisites section and improve clarity #381

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 4 additions & 0 deletions docs/examples/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
10 changes: 4 additions & 6 deletions docs/examples/python/cli-reference-agent.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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

Expand Down
2 changes: 1 addition & 1 deletion docs/user-guide/quickstart.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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:

Expand Down
2 changes: 1 addition & 1 deletion docs/user-guide/quickstart/python.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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:

Expand Down