Skip to content

docs: enhance README with 1.0 features and improved structure - #5534

Merged
Shawn Henry (sphenry) merged 8 commits into
mainfrom
feature/improve-readme
May 5, 2026
Merged

docs: enhance README with 1.0 features and improved structure#5534
Shawn Henry (sphenry) merged 8 commits into
mainfrom
feature/improve-readme

Conversation

@chetantoshniwal

@chetantoshniwalchetantoshniwal commented Apr 28, 2026

Copy link
Copy Markdown
Contributor

Summary

This PR improves the main README to better communicate Microsoft Agent Framework's capabilities,
streamline navigation, and reduce redundancy.

Changes

Structure & Navigation

  • Added Table of Contents with anchor links for all major sections
  • Moved Key Features section immediately after "Is this the right framework?" — so readers see capabilities at the decision point
  • Reordered sections for logical flow: Install → Learning Resources → Quickstart → Samples → Community
  • Renamed "Documentation" heading to Learning Resources to better reflect mixed content (tutorials, guides, migrations)

Content Improvements

  • Renamed "Highlights" to ✨ Key Features and promoted it as a top-level section
  • Added new feature callouts for 1.0 launch:
    • Orchestration Patterns & Workflows — sequential, concurrent, handoff, group collaboration
    • Foundry Hosted Agents — deploy with 2 additional lines of code
    • Agent Skills — multi-source domain knowledge bases
    • AF Labs — experimental features including CodeAct, Agent Lightning, GAIA/TAU2
  • Rewrote Community & Feedback section with clear action items and GitHub star badge
  • Replaced Environment Variables table with a note pointing to sample-specific READMEs

Fixes

  • Fixed Quickstart heading typography (Unicode minus → regular hyphen) for working anchor links
  • Updated TOC Quickstart entry with Python and .NET subsection links

@chetantoshniwal
docs: enhance README with 1.0 features and improved structure
1554490
- 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)
CopilotAI review requested due to automatic review settings April 28, 2026 06:23
@moonbox3Evan Mattson (moonbox3) added the documentation Usage: [Issues, PRs], Target: documentation in the code base and learn docs label Apr 28, 2026
CopilotAI reviewed Apr 28, 2026
View reviewed changes

CopilotAI left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

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.

Comment threadREADME.md Outdated
Comment threadREADME.md Outdated
Comment threadREADME.md
Comment threadREADME.md
github-actions[bot]
github-actionsBot reviewed Apr 28, 2026
View reviewed changes

@github-actionsgithub-actionsBot left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

Automated Code Review

Reviewers: 4 | Confidence: 84% | Result: All clear

Reviewed: Correctness, Security Reliability, Test Coverage, Design Approach

Automated review by chetantoshniwal's agents

@chetantoshniwal
Apply suggestions from code review
f248be0
Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>
@chetantoshniwal
docs: fix .NET quickstart description to match JokerAgent code
573aa00
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>
@chetantoshniwal
docs: add required NuGet packages for .NET Foundry quickstart
78a975c
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
Evan Mattson (moonbox3) reviewed Apr 29, 2026
View reviewed changes
Comment threadREADME.md Outdated
Comment threadREADME.md Outdated
chetantoshniwaland others added 2 commits April 28, 2026 17:17
@chetantoshniwal@moonbox3
Update README.md
1b7efad
Co-authored-by: Evan Mattson <35585003+moonbox3@users.noreply.github.com>
@chetantoshniwal
docs: remove emojis from README
668862c
sphenry
Shawn Henry (sphenry) reviewed Apr 29, 2026
View reviewed changes
Comment threadREADME.md Outdated
Comment threadREADME.md Outdated
@sphenry
Shawn Henry (sphenry) added this pull request to the merge queueMay 5, 2026
Merged via the queue into main with commit 7476049May 5, 2026
19 checks passed
This was referenced May 5, 2026
Closed
Closed
Closed
Closed
Closed
This was referenced Jun 5, 2026
Closed
Closed
Closed
Closed
Closed
Closed
Closed
Closed
Closed
Open
Open
This was referenced Jun 12, 2026
Closed
Closed
Closed
Closed
Closed
This was referenced Jun 24, 2026
Closed
Closed
Open
Closed
Closed
This was referenced Jul 1, 2026
Closed
Closed
Closed
Closed
This was referenced Jul 8, 2026
Closed
Closed
Open
Closed
@dependabotdependabotBot mentioned this pull request Jul 26, 2026
Merged
Sign up for freeto join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@github-actionsgithub-actions[bot]github-actions[bot] left review comments
Copilot code reviewCopilot
Copilot review effort
Applies to this pull request for everyone.Learn more about Copilot code review.
Copilot left review comments
Copilot code reviewCopilotCopilot left review comments
@sphenryShawn Henry (sphenry)sphenry approved these changes
@moonbox3Evan Mattson (moonbox3)moonbox3 approved these changes

Assignees

No one assigned

Labels

documentationUsage: [Issues, PRs], Target: documentation in the code base and learn docs

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

5 participants

@chetantoshniwal@sphenry@moonbox3