Skip to content

docs: update AgentRegistry API reference - #1610

Closed
thunderisme wants to merge 2 commits into
kyegomez:masterfrom
thunderisme:docs/agent-registry-api-reference
Closed

docs: update AgentRegistry API reference#1610
thunderisme wants to merge 2 commits into
kyegomez:masterfrom
thunderisme:docs/agent-registry-api-reference

Conversation

@thunderisme

@thunderisme thunderisme commented May 13, 2026

Copy link
Copy Markdown

Summary

  • Update the AgentRegistry documentation to match the current implementation.
  • Correct the stale add(agent_id, agent) and ID-keyed examples; add now accepts an Agent and stores it by agent.agent_name.
  • Replace the provider-heavy example with a concise local example covering add, list, get, query, update, and delete.
  • Document the current constructor, method surface, and schema metadata fields.
  • Add the minimal Read the Docs build config/support files used by recent passing docs PRs so the preview can build from this branch.

Bounty eligibility

  • Label requested: bounty-eligible / 🙋 Bounty claim
  • Expected tier: Silver or Gold, at maintainer discretion
  • Rationale: this updates outdated AgentRegistry references and examples with behavior verified against swarms/structs/agent_registry.py; the RTD config files are included only to keep the docs preview buildable from this branch.

Verification

  • Compared docs/swarms/structs/agent_registry.md against swarms/structs/agent_registry.py.
  • Confirmed no open PR currently modifies docs/swarms/structs/agent_registry.md.
  • Ran git diff --check.
  • Confirmed recent docs PRs with the same RTD support pattern have passing Read the Docs checks.

@github-actions github-actions Bot added the documentation Improvements or additions to documentation label May 13, 2026
@github-actions

Copy link
Copy Markdown

Hello there, thank you for opening an PR ! 🙏🏻 The team was notified and they will get back to you asap.

@thunderisme

Copy link
Copy Markdown
Author

I could not apply the repository bounty label from the fork account. If this documentation update qualifies under the docs bounty program, please apply the appropriate bounty label during review. The bounty rationale is included in the PR description.

@kyegomez kyegomez closed this Jun 3, 2026
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

documentation Improvements or additions to documentation

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants