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

Improve language of user guide #4577

Merged
merged 9 commits into from
Dec 10, 2024
Merged

Improve language of user guide #4577

merged 9 commits into from
Dec 10, 2024

Conversation

gagb
Copy link
Collaborator

@gagb gagb commented Dec 5, 2024

This pull request improves the documentation for the AssistantAgent and teams features in the python/packages/autogen-core/docs/src/user-guide/agentchat-user-guide/tutorial/ directory. The changes enhance clarity, readability, and organization of the content. The most important changes include rephrasing sentences for better comprehension, restructuring sections, and adding new headings for better navigation.

Improvements to AssistantAgent documentation:

  • Clarified the description of the AssistantAgent's capabilities.
  • Added a new heading for the section on getting responses and improved the explanation.
  • Changed the heading for the streaming messages section to be more consistent.
  • Added context to the example code comments for better understanding.
  • Improved the explanation of the on_messages_stream method and tool usage.
  • Rephrased the transition to the next section for better flow.

Improvements to teams documentation:

  • Reorganized the introduction to creating and running teams, and removed redundant information.
  • Changed section headings for better consistency and readability. [1] [2]
  • Improved the explanation and structure of the reflection pattern example.
  • Added a new section on controlling a team and moved relevant content for better organization.
  • Changed headings and rephrased content for better clarity in the sections on resuming tasks and pausing for user input. [1] [2] [3] [4]

@gagb gagb requested review from Copilot, ekzhu, gziz and victordibia and removed request for Copilot and ekzhu December 9, 2024 22:27
@gagb gagb marked this pull request as ready for review December 9, 2024 22:27

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Copilot reviewed 2 out of 2 changed files in this pull request and generated no suggestions.

@gagb gagb requested a review from husseinmozannar December 10, 2024 00:30
@ekzhu ekzhu merged commit f5140ba into main Dec 10, 2024
45 checks passed
@ekzhu ekzhu deleted the gagb-docs branch December 10, 2024 02:56
ekzhu added a commit that referenced this pull request Dec 10, 2024
* Improve language of agents section

* Accomodate victor's feedback

* Templ changes

* Change outline

* Fix outline further

* Flatten the outline

* remove

---------

Co-authored-by: Eric Zhu <[email protected]>
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.

2 participants