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

Changes in README.md #3838

Open
wants to merge 26 commits into
base: main
Choose a base branch
from
Open

Changes in README.md #3838

wants to merge 26 commits into from

Conversation

faizanwasif
Copy link

Why are these changes needed?

These changes are necessary to improve the overall clarity, consistency, and professionalism of the README.md documentation for the AutoGen project. The modifications include correcting grammatical errors, fixing typos, and enhancing formatting throughout the document. These improvements will help users better understand the framework’s features, installation instructions, and usage examples, ultimately enhancing their experience with AutoGen.

faizanwasif added 3 commits October 18, 2024 15:30
- Corrected typos and improved clarity in important notes.
- Enhanced formatting for key features, installation instructions, and API layering.
- Standardized language throughout the document for better readability.
- Updated URLs and code snippets for accuracy.
- Corrected typos and improved clarity in important notes.
- Enhanced formatting for key features, installation instructions, and API layering.
- Standardized language throughout the document for better readability.
- Updated URLs and code snippets for accuracy.
- Corrected typos and improved clarity in important notes.
- Enhanced formatting for key features, installation instructions, and API layering.
- Standardized language throughout the document for better readability.
- Updated URLs and code snippets for accuracy.
Copy link
Member

@jackgerrits jackgerrits left a comment

Choose a reason for hiding this comment

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

There are some good edits here - but can you please revert the changes where you are condensing multiple lines into 1. This makes the diff unnecessarily large and hard to see the content changes.

README.md Outdated Show resolved Hide resolved
README.md Outdated Show resolved Hide resolved
@rysweet rysweet added the awaiting-op-response Issue or pr has been triaged or responded to and is now awaiting a reply from the original poster label Oct 18, 2024
Co-authored-by: Jack Gerrits <[email protected]>
@faizanwasif
Copy link
Author

@microsoft-github-policy-service agree

@jackgerrits
Copy link
Member

There are still a large number white space and new line changes, can you please revert those

@rysweet rysweet removed the awaiting-op-response Issue or pr has been triaged or responded to and is now awaiting a reply from the original poster label Oct 21, 2024
@ekzhu ekzhu added the documentation Improvements or additions to documentation label Oct 21, 2024
@jackgerrits
Copy link
Member

I still see many changes around removing new lines that are not needed for the proposed content changes. For example the entire legal section. If you would like to resolve all such changes then we can consider this PR.

We are aware that there are thousands of forks of AutoGen, including many for personal development and startups building with or on top of the library. We are not involved with any of these forks and are not aware of any plans related to them.
https://github.com/microsoft/autogen/ remains the only official repo for development and support of AutoGen.
We are aware that there are thousands of forks of AutoGen, including many for personal development and startups building with or on top of the library.
We are not involved with any of these forks and are not aware of any plans related to them.
Copy link
Collaborator

Choose a reason for hiding this comment

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

Can we not have these new line edits (this and many others in this PR) if there is not edit to the context. Thanks!

Our current plan is to enable an implementation of AutoGen Studio
on the AgentChat high level API which implements a set of agent functionalities
(agents, teams, etc).

### How do I migrate?

For users familiar with AutoGen, the AgentChat library in 0.4 provides similar concepts.
We are working on a migration guide.
For users familiar with AutoGen, the AgentChat library in 0.4 provides similar concepts. We are working on a migration guide.
Copy link
Collaborator

Choose a reason for hiding this comment

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

Please revert these new line edits, and many other ones in this file. Thanks!

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.

4 participants