Skip to content

Update documentation to highlight top-level Agent import #1030

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

Open
wants to merge 1 commit into
base: develop
Choose a base branch
from

Conversation

codegen-sh[bot]
Copy link
Contributor

@codegen-sh codegen-sh bot commented Apr 8, 2025

This PR updates the documentation to highlight that the Agent class can be imported directly from the top-level package using from codegen import Agent.

The Agent class was already properly exposed in the top-level __init__.py file, but the documentation examples were still using the longer import path. This PR updates:

  1. The main README.md to show the Agent import in the usage examples
  2. The agents/README.md to show both import options with the top-level import as the recommended approach

This addresses the request from @jay Hack to make the Agent class available as a top-level import.


💻 View my workAbout Codegen

@codegen-sh codegen-sh bot requested review from codegen-team and a team as code owners April 8, 2025 19:03
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.

None yet

0 participants