docs: add llms.txt index for AutoGen documentation (#6271)#7634
Open
MukundaKatta wants to merge 1 commit intomicrosoft:mainfrom
Open
docs: add llms.txt index for AutoGen documentation (#6271)#7634MukundaKatta wants to merge 1 commit intomicrosoft:mainfrom
MukundaKatta wants to merge 1 commit intomicrosoft:mainfrom
Conversation
Adds python/docs/src/llms.txt following the llmstxt.org spec. The file indexes the AutoGen documentation guides (AgentChat, Core, Extensions, AutoGen Studio, plus design patterns, cookbook, and API reference) with canonical https://microsoft.github.io/autogen/stable/...html URLs and a short tagline per page so LLM agents can discover and fetch the docs. Wires html_extra_path in python/docs/src/conf.py so the file is served at the docs site root (e.g. microsoft.github.io/autogen/stable/llms.txt and the matching dev path). Closes microsoft#6271
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
Closes #6271. Adds
python/docs/src/llms.txtfollowing the llmstxt.org format and wireshtml_extra_pathso Sphinx serves it at the docs site root.What's in it
https://microsoft.github.io/autogen/stable/.../...htmlURLs (so LLM agents can actually fetch the pages).:link-alt:cards in the section index pages.llms-txtPython parser.Differentiator vs prior attempts
Prior PR #7623 used repo-relative
.mdsource paths (not fetchable by LLM agents). This PR uses canonical HTML URLs, covers more pages, and wires the build to actually servellms.txtat the docs root.Test plan
llms-txtreference parser.html_extra_path = ["llms.txt"]placed alongside existing static config inconf.py.