-
Notifications
You must be signed in to change notification settings - Fork 407
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.
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
docs(event_handler): add bedrock agent resolver documentation #3602
Conversation
b498cc0
to
c729d29
Compare
Quality Gate passedThe SonarCloud Quality Gate passed, but some issues were introduced. 1 New issue |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
This new Resolver for Bedrock Agents is truly a game changer @rubenfonseca!
I left some comments and I think we need to make it more clear to the customers:
1 - Create a diagram explaining how the Bedrock Agent works with Lambda.
2 - Add the video you are creating to make clear the amazing value-added of this utility.
3 - We need to rethink some sections of this documentation. I think we are investing a lot of documentation in SwaggerUI and not enough in Bedrock Agent, and the problems that this new Resolver solves.
Thanks brother ❤️
Please retry analysis of this Pull-Request directly on SonarCloud |
Bedrock reviewI love the user-experience. It makes authoring Agents as easy as writing an API - straight to the point, readable by anyone. For documentation, these are key areas we discussed during docs review that can take the current documentation to the next level: Tip Mental model
Items
PS: @hjgraca please chime in if I missed anything from today's session. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Minor changers
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
There's a few places where you're using a singular agent as "Agent" (cap 'A') where it should be lower case. "Agent" refers to the feature not the concept (if that makes sense)
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Hello @rubenfonseca! We have some wrong characters that are breaking the links. I made suggestions to correct it.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Hello @rubenfonseca! Another batch of small suggestions! Thanks.
examples/event_handler_bedrock_agents/src/getting_started_schema.json
Outdated
Show resolved
Hide resolved
examples/event_handler_bedrock_agents/src/getting_started_with_validation.py
Show resolved
Hide resolved
examples/event_handler_bedrock_agents/src/getting_started_with_validation_schema.json
Outdated
Show resolved
Hide resolved
examples/event_handler_bedrock_agents/src/generating_openapi_schema.json
Outdated
Show resolved
Hide resolved
Quality Gate passedIssues Measures |
@leandrodamascena sorry for the mess, everything should be fixed now |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Congrats to everyone who contributed to this PR. We always make a difference in the lives of our customers when we provide very clear and concise documentation.
APPROVED!
Issue number: #3326
Summary
Changes
This PR adds documentation to the Bedrock Agent resolver feature.
Note: to allow sharing content between REST and Bedrock Agents resolvers, some content was moved to shared files and imported in both sides.
User experience
Checklist
If your change doesn't seem to apply, please leave them unchecked.
Is this a breaking change?
RFC issue number:
Checklist:
Acknowledgment
By submitting this pull request, I confirm that you can use, modify, copy, and redistribute this contribution, under the terms of your choice.
Disclaimer: We value your time and bandwidth. As such, any pull requests created on non-triaged issues might not be successful.