Skip to content

Python: [Bug]: python/README.md still says "Learn docs are coming soon" #7771

Closed

Description

Description

What happened: python/README.md ends its "Agent Framework Documentation" section with a placeholder line instead of a link:

https://github.com/microsoft/agent-framework/blob/main/python/README.md#L261

- Learn docs are coming soon.

What was expected: a link to the Learn documentation, which is published and already linked from the rest of the repo:

  • root README.md lines 96-101 (Overview, Quick Start, Tutorials, User Guide, migration guides)
  • dotnet/README.md lines 31 and 35
  • .github/ISSUE_TEMPLATE/config.yml, which points contributors at https://aka.ms/agent-framework
  • Python-pivot pages linked from Python sample and package READMEs, e.g. python/packages/azure-cosmos-memory/README.md:475 and python/samples/04-hosting/foundry-hosted-agents/responses/observability/README.md:19

So the Python package README is the only place still telling readers the docs do not exist yet.

Steps to reproduce: open https://github.com/microsoft/agent-framework/tree/main/python and scroll to "Agent Framework Documentation".

Suggested fix

Replace the placeholder with the Learn links, Python-pivoted where the page supports pivots:

- [Learn Documentation](https://learn.microsoft.com/agent-framework/) - Official documentation
- [Quick Start](https://learn.microsoft.com/agent-framework/tutorials/quick-start?pivots=programming-language-python)
- [User Guide](https://learn.microsoft.com/en-us/agent-framework/user-guide/overview?pivots=programming-language-python)

Package Versions

N/A - repository documentation (python/README.md), main at 26b9200.

Additional Context

The same list has a second stale entry one line above: [Design Documents] points to docs/design, which contains only python-package-setup.md. The design records (ADRs) live in docs/decisions. Both lines could be corrected in one PR.

Searched open and closed issues before filing; no existing report covers this.

Activity

  1. added
    .NETUsage: [Issues, PRs], Target: .Net
    pythonUsage: [Issues, PRs], Target: Python
    triageUsage: [Issues], Target: All issues that still need to be triaged
    on Aug 19, 2026
  2. changed the title [-]Python: [Bug]: python/README.md still says "Learn docs are coming soon"[/-] [+].NET: Python: [Bug]: python/README.md still says "Learn docs are coming soon"[/+] on Aug 19, 2026
  3. changed the title [-].NET: Python: [Bug]: python/README.md still says "Learn docs are coming soon"[/-] [+]Python: [Bug]: python/README.md still says "Learn docs are coming soon"[/+] on Aug 19, 2026
  4. added
    reproducedUsage: [Issues], Target: all issues that can be reproduced by the triage workflow
    on Aug 19, 2026
  5. github-actions commented on Aug 19, 2026

    @github-actions
    Contributor

    🤖 Automated triage reproduction notes (agent-authored — trust but verify)

    Agent analysis

    The bug is in python/README.md line 261 which reads "Learn docs are coming soon." — a stale placeholder. Replace it with Learn documentation links matching the pattern used in the root README.md (lines 96-98) and dotnet/README.md (lines 31, 35), using Python-pivoted URLs where available. The reporter also notes line 260's Design Documents link may point to the wrong directory (docs/design vs docs/decisions).

    • Failing test: none
    • Files examined: python/README.md, README.md, dotnet/README.md
    • Tests run: none
  6. removed
    triageUsage: [Issues], Target: All issues that still need to be triaged
    on Aug 19, 2026
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Metadata

Metadata

Labels

.NETUsage: [Issues, PRs], Target: .NetpythonUsage: [Issues, PRs], Target: PythonreproducedUsage: [Issues], Target: all issues that can be reproduced by the triage workflow

Type

Projects

Milestone

No milestone

Relationships

None yet

Development

No branches or pull requests

Issue actions