docs: enhance README with 1.0 features and improved structure#5534
Open
chetantoshniwal wants to merge 7 commits intomainfrom
Open
docs: enhance README with 1.0 features and improved structure#5534chetantoshniwal wants to merge 7 commits intomainfrom
chetantoshniwal wants to merge 7 commits intomainfrom
Conversation
- Add GitHub star badge button for easier community engagement - Reorganize highlights to emphasize Foundry Hosted Agents, Agent Skills, and Orchestration Patterns - Add CodeAct callout in AF Labs experimental features - Improve Community & Feedback section with clearer call-to-action structure - Add Table of Contents for better navigation - Fix 'quickstar' typo to 'quickstart' - Reorder sections for improved readability (docs before code examples)
Contributor
There was a problem hiding this comment.
Pull request overview
Updates the repository’s main README to better communicate Microsoft Agent Framework’s production-focused capabilities, improve navigation, and refresh 1.0-era feature messaging for both Python and .NET audiences.
Changes:
- Adds a new “Is this the right framework for you?” section and promotes “✨ Key Features” earlier in the README.
- Introduces a Table of Contents and reorganizes sections for a clearer learning path.
- Refreshes Quickstart and Community sections; replaces the environment variables table with pointers to sample-specific READMEs.
![github-actions[bot]](https://avatars.githubusercontent.com/in/15368?s=60&v=4){kind=small}
Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>
Agent-Logs-Url: https://github.com/microsoft/agent-framework/sessions/a0616215-1b8a-44ea-9a35-3ef33b97bdce Co-authored-by: chetantoshniwal <255221507+chetantoshniwal@users.noreply.github.com>
Agent-Logs-Url: https://github.com/microsoft/agent-framework/sessions/a035ce2c-e2e0-4b8d-b340-550704220975 Co-authored-by: chetantoshniwal <255221507+chetantoshniwal@users.noreply.github.com>
moonbox3
reviewed
Apr 29, 2026
Co-authored-by: Evan Mattson <35585003+moonbox3@users.noreply.github.com>
moonbox3
approved these changes
Apr 29, 2026
sphenry
reviewed
Apr 29, 2026
| - care about durability, restartability, observability, governance, or human-in-the-loop control, | ||
| - need provider flexibility so your architecture can evolve without major rewrites. | ||
|
|
||
| If your scope is limited to experimentation or simple single-prompt chatbots, |
Member
There was a problem hiding this comment.
I don't think we need this line, it's implied by the 'strong fit' section. Also, it will be more nuanced with the harness features
| Microsoft Agent Framework (MAF) is an open, multi-language framework for building **production-grade AI agents and multi-agent workflows** in **.NET and Python**. | ||
|
|
||
| It is designed for teams moving beyond prototypes who need: | ||
| - a consistent agent programming model with tools, middleware, and provider flexibility, |
Member
There was a problem hiding this comment.
This content is duplicated below (Key Features), I think we only need it once, and I think I like the later section better
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
This PR improves the main README to better communicate Microsoft Agent Framework's capabilities,
streamline navigation, and reduce redundancy.
Changes
Structure & Navigation
Content Improvements
Fixes