Skip to content
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

Add documentation about when an endpoint parameter is required for the Bureau class #575

Open
2 tasks done
flotoria opened this issue Nov 9, 2024 · 1 comment
Open
2 tasks done
Assignees
Labels
a-documentation Area: Documentation - changes to the documentation only c-feature Category: New feature or request s-confirmed Status: This is a confirmed issue

Comments

@flotoria
Copy link

flotoria commented Nov 9, 2024

Prerequisites

  • I checked the documentation and made sure this feature does not already exist
  • I checked the existing issues to make sure this feature has not already been requested

Feature

While looking at Fetch.ai's uAgents framework documentation, we noticed that our agents were not registering on the Almanac Contract.

Looking at this documentation, we noticed that our agents, that were added into a Bureau, were not registering on the Almanac Contract; thus, we could not communicate with the agents at all. We were using the code example in the image below and the documentation specified, and it was not registering on the Almanac Contract. The endpoint parameter is specified as optional, but in this case, it is required even when the agents have an endpoint parameter specified.

image

It pops up with this warning when no endpoint is provided for the bureau:
WARNING: [Risk Analyzer Agent]: No endpoints provided. Skipping registration: Agent won't be reachable.

In the documentation linked above, there should be more clarification on when the endpoint parameter for the Bureau class needs to be specified. The code examples might need to be updated as well. It would also probably be best to also specify when a bureau needs an endpoint parameter in the logs itself.

Perhaps something similar to:
[bureau]: No endpoint parameter specified for the bureau. All agents in this bureau won't be reachable.

Additional Information (Optional)

Was told to create an issue about this by our Fetch.ai mentors.

@flotoria flotoria changed the title Add documentation regarding needing an endpoint parameter for the Bureau class Add documentation about when an endpoint parameter is required for the Bureau class Nov 9, 2024
@jrriehl jrriehl added a-documentation Area: Documentation - changes to the documentation only c-feature Category: New feature or request labels Nov 11, 2024
@jrriehl
Copy link
Contributor

jrriehl commented Nov 11, 2024

Great suggestion! Sorry you faced some confusion because of this, but it sounds like you resolved it in the end. Thanks for opening the issue and we'll make sure to get this into the docs and the next release.

@Archento Archento added the s-confirmed Status: This is a confirmed issue label Nov 11, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
a-documentation Area: Documentation - changes to the documentation only c-feature Category: New feature or request s-confirmed Status: This is a confirmed issue
Projects
None yet
Development

No branches or pull requests

3 participants