docs: improve marketing_agent example README#3478
Open
Ansh0928 wants to merge 1 commit intoadenhq:mainfrom
Open
docs: improve marketing_agent example README#3478Ansh0928 wants to merge 1 commit intoadenhq:mainfrom
Ansh0928 wants to merge 1 commit intoadenhq:mainfrom
Conversation
Fixes adenhq#2987 Added Prerequisites (API keys) and Example Output sections to provide a better onboarding experience for new users, as requested in issue adenhq#2987.
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
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.
Fixes #2987
Problem
As identified in issue #2987, example agent documentation was inconsistent. Specifically, the
marketing_agenttemplate was missing information on required API keys and did not provide a sample of the expected output.Solution
Enhanced
examples/templates/marketing_agent/README.mdwith:ANTHROPIC_API_KEY.This provides a much better onboarding experience for new users trying out these examples.