Skip to content

Add llms.txt for AutoGen documentation #6613

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

Open
wants to merge 7 commits into
base: main
Choose a base branch
from

Conversation

tejas-dharani
Copy link
Contributor

Description

Why are these changes needed?

This PR implements the llms.txt specification for AutoGen's documentation to help AI systems better understand and navigate the project's documentation structure. The llms.txt format provides curated, LLM-friendly access to documentation, making it easier for AI assistants to help users with AutoGen-related questions.

What does this PR do?

  • Adds /llms.txt file following the official specification from https://llmstxt.org/
  • Organizes AutoGen documentation into logical sections (Core, Tutorials, API Reference, etc.)
  • Provides concise descriptions for each documentation link to guide AI systems
  • Includes both essential and optional content sections for context-aware information retrieval

Related issue number

Closes #6271

Checks

  • I've included the llms.txt file in the repository root
  • All URLs in the file are valid and accessible
  • The file follows the official llms.txt specification format
  • Content is organized from most essential to optional sections
  • Link descriptions are concise and helpful for AI understanding

Additional Notes

The llms.txt file is structured to help AI systems quickly understand:

  1. What AutoGen is - Multi-agent AI framework description
  2. How to get started - Core documentation and installation guides
  3. Learning resources - Tutorials and examples
  4. Technical reference - API documentation for both Python and .NET
  5. Advanced topics - Optional sections for deeper exploration

This will benefit the AutoGen community by improving AI-assisted development experiences and making documentation more accessible to LLM-powered tools.

…on guide- Fix version format from 0.4.0-dev-1 to 0.4.0-dev.1 for all packages- Remove reference to non-existent Microsoft.AutoGen.Extensions package- Add correct extension packages: Aspire, MEAI, and SemanticKernel- Fix typo: RuntimeGatewway -> RuntimeGateway- Improve documentation structure with clear section headersFixes microsoft#6244
Fix issue microsoft#6277 where TextMessage was used but not imported in three code cells
of the custom agents documentation, causing NameError when users run the examples.

Changes:
- Add TextMessage to imports in ArithmeticAgent section
- Add TextMessage to imports in GeminiAssistantAgent section
- Add TextMessage to imports in Declarative GeminiAssistantAgent section

The CountDownAgent section already had the correct import.

Fixes microsoft#6277
Implements GitHub issue microsoft#6271 by adding an llms.txt file to help AI systems
better understand and navigate AutoGen's documentation structure.

The file includes:
- Clear description of AutoGen's multi-agent framework architecture
- Core documentation links (quickstart, installation, migration guide)
- Comprehensive tutorials and examples for AgentChat, Core API, and Extensions
- Complete API reference for both Python and .NET implementations
- AutoGen Studio no-code GUI documentation
- Advanced topics and community resources in optional section

Follows the official llms.txt specification with proper markdown structure
and concise, actionable descriptions for each documentation link.
Copy link
Contributor

@ShyamSathish005 ShyamSathish005 left a comment

Choose a reason for hiding this comment

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

Please ensure all the referenced packages are actually published with the updated version format (0.4.0-dev.1), so users won’t encounter errors.

@tejas-dharani
Copy link
Contributor Author

@microsoft-github-policy-service agree

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.

LLMs.txt for AutoGen Documentation Guides
2 participants