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

docs: enhance README with key features and practical examples #546

Merged
merged 5 commits into from
Feb 8, 2025

Conversation

crStiv
Copy link
Contributor

@crStiv crStiv commented Jan 19, 2025

Improve README.md documentation with the following enhancements:

  • Add Key Features section for quick overview of AG2 capabilities
  • Include navigation links for better document accessibility
  • Restructure "What is AG2" section with Core Concepts
  • Add practical code examples for basic usage scenarios
  • Improve overall document structure and readability

These changes make the documentation more user-friendly and
help new contributors quickly understand AG2's capabilities.

@sonichi
Copy link
Collaborator

sonichi commented Jan 19, 2025

@crStiv thanks for the contribution. There's some wording I'd like to change. Could you invite me to the repo? Also, would you like to join our Discord server: discord.gg/ag2 and become a verified dev?

@davorrunje davorrunje self-assigned this Jan 20, 2025
@crStiv
Copy link
Contributor Author

crStiv commented Feb 1, 2025

@crStiv thanks for the contribution. There's some wording I'd like to change. Could you invite me to the repo? Also, would you like to join our Discord server: discord.gg/ag2 and become a verified dev?

@sonichi yes sure, I sent you an invitation.

@sonichi
Copy link
Collaborator

sonichi commented Feb 4, 2025

@crStiv thanks for the contribution. There's some wording I'd like to change. Could you invite me to the repo? Also, would you like to join our Discord server: discord.gg/ag2 and become a verified dev?

@sonichi yes sure, I sent you an invitation.

Thanks. Feel free to reach out to me on Discord: sonichi

README.md Outdated Show resolved Hide resolved
@CLAassistant
Copy link

CLAassistant commented Feb 5, 2025

CLA assistant check
All committers have signed the CLA.

@sonichi sonichi added this pull request to the merge queue Feb 8, 2025
Merged via the queue into ag2ai:main with commit 6d8114c Feb 8, 2025
14 checks passed
@sonichi sonichi deleted the fix branch February 8, 2025 00:10
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.

5 participants