Skip to content

Improve README formatting and Python quickstart example - #10241

Open
Dhruva Kumar (dhruvatr) wants to merge 1 commit into
microsoft:mainfrom
dhruvatr:patch-1
Open

Dhruva Kumar (dhruvatr) wants to merge 1 commit into
microsoft:mainfrom
dhruvatr:patch-1

Conversation

@dhruvatr

Copy link
Copy Markdown

Motivation & Context

Description & Review Guide

  • What are the major changes?
  • What is the impact of these changes?
  • What do you want reviewers to focus on?

Related Issue

Fixes #

AI Assistance

  • No material AI assistance was used.
  • This is an AI-assisted contribution. I reviewed, understood, and verified all submitted content and accept responsibility for it.

AI assistance details:

Contribution Checklist

  • The code builds clean without any errors or warnings
  • All unit tests pass, and I have added new tests where possible
  • The PR follows the Contribution Guidelines
  • This PR links to an agreed issue with no competing open PR, or the Related Issue section documents a trivial-change or repository-automation exception.
  • This is not a breaking change. If it is a breaking change, add the breaking change label (or add "[BREAKING]" to the title prefix, before or after any language prefix) — a workflow keeps the label and title prefix in sync automatically.

This PR improves the Microsoft Agent Framework README by making minor documentation and formatting corrections.

Copilot AI 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.

🟡 Changes recommended

Removing the os import breaks the documented project_endpoint and model overrides, causing a NameError when either is uncommented.

1 open issue
What changed in this PR

This PR makes small edits to the Microsoft Agent Framework’s main README, focusing on the Python quickstart and documentation formatting.

Changes:

  • Removes import os from the Python quickstart example.
  • Adds a space after a blockquote marker in the third-party systems notice.
File Description
README.md Adjusts quickstart imports and blockquote formatting.

Review effort: Balanced

Comment thread README.md
# pip install agent-framework
# Use `az login` to authenticate with Azure CLI
import os
import asyncio

This branch was successfully deployed

1 active deployment
github-app-auth — 5ae4a2d0 Deployed Nov 10, 2026 by dhruvatr via team_check #9220
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

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

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants