LLMs.txt for AutoGen Documentation Guides · microsoft/autogen#6271

(9 comments) (2 reactions) (0 assignees)Python (58,033 stars) (8,759 forks)batch import

documentationhelp wanted

Description

For each page in documentation, we can compile a comparable llms.txt (or llms.md??) with markdown compilation of the content. The links in it should also reference corresponding links in llms.txt.

Discussed in https://github.com/microsoft/autogen/discussions/6262

Originally posted by cc0zh April 10, 2025 Hello AutoGen Team, I hope this message finds you well. I'd like to suggest adding an LLMs.txt file specifically for the AutoGen user guide documentation hosted at https://microsoft.github.io/autogen/stable/user-guide/. An LLMs.txt file can provide valuable directives for large language models (LLMs) and AI agents interacting with the documentation. This guidance could include preferred crawl paths, sections suitable for summarization, disallowed areas, citation preferences, etc.

Contributor guide

Tech stack: python
Domain: documentation
Issue type: feature
Difficulty: 2
Estimated time: 1-3 hours
Activity status: fresh
Clarity: mostly clear
Prerequisites: basic markdownunderstanding of AutoGen docs structure
Newbie friendliness: 75
Research direction: Start by reading the linked discussion in https://github.com/microsoft/autogen/discussions/6262 to understand the motivation and any specific guidelines. Then explore the existing documentation at https://microsoft.github.io/autogen/stable/user guide/ and its source in the repository under the 'docs' folder. For each documentation page, create an llms.md file that compiles the page content in markdown and includes links referencing corresponding sections. Ensure the output is consistent with the existing documentation structure. There are no open pull requests or blockers, but check comments for any clarifications needed.