Skip to content

Conversation

@azarboon
Copy link
Contributor

@azarboon azarboon commented Dec 12, 2025

Description

Add prerequisites to the documentation of the Agentic Workflow: Research Assistant example.

Type of Change

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

Content update/revision

Motivation and Context

To function correctly, users must have configured AWS credentials and have access to the AWS Bedrock Claude 4 model; however, this requirement is not mentioned on the page. The original content assumes preexisting knowledge, which can be confusing. I have added a prerequisites section to simplify onboarding for beginners. Other examples, such as docs/examples/python/cli-reference-agent.md, include a clear and explicit prerequisites section. This update enhances consistency and improves user experience across the documentation.

Areas Affected

  • docs/examples/python/agents_workflows.md ## Prerequisites

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.

@lizradway
Copy link
Member

Hi there -- thanks for the contribution! Since the cli-reference-agent example is the only listed example that includes a "Prerequisites" section and prerequisite setup is already included on our "Getting Started" page as well as the "Examples" homepage, our user should already be aware of prequisites when using this example.

If you would want to contribute the removal of the prerequisites section from our cli-reference-agent example in order to preserve consistency, please rebase and revise the PR. Thanks so much!

@azarboon
Copy link
Contributor Author

Hi there -- thanks for the contribution! Since the cli-reference-agent example is the only listed example that includes a "Prerequisites" section and prerequisite setup is already included on our "Getting Started" page as well as the "Examples" homepage, our user should already be aware of prequisites when using this example.

If you would want to contribute the removal of the prerequisites section from our cli-reference-agent example in order to preserve consistency, please rebase and revise the PR. Thanks so much!

@lizradway I created a new, improved PR #381 and incorporated your suggestions.

@azarboon azarboon closed this Dec 18, 2025
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