Document in-HTML llms.txt directive for AI discoverability#5581
Open
mintlify[bot] wants to merge 1 commit intomainfrom
Open
Document in-HTML llms.txt directive for AI discoverability#5581mintlify[bot] wants to merge 1 commit intomainfrom
mintlify[bot] wants to merge 1 commit intomainfrom
Conversation
Generated-By: mintlify-agent
Contributor
Author
|
Preview deployment for your docs. Learn more about Mintlify Previews.
|
Contributor
|
Preview deployment for your docs. Learn more about Mintlify Previews.
|
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
A recent change ships a new discoverability mechanism: every rendered documentation page now contains a hidden, screen-reader-only blockquote that points AI agents to the site's
llms.txtfile. This complements the existing HTTP headers (Link,X-Llms-Txt) by giving agents that parse the page DOM (rather than HTTP responses) a clear pointer to the documentation index.Changes
ai/llmstxt.mdxto describe the new HTML directive alongside the existing HTTP header discovery methods, including an example of the injected markup.The directive is automatic and requires no configuration from users.
Note
Low Risk
Documentation-only change describing an additional AI discoverability mechanism; no runtime code or data-handling behavior is modified.
Overview
Updates the
llms.txtdocumentation to describe a new in-HTML discoverability directive that Mintlify injects into every rendered page, complementing the existingLinkandX-Llms-TxtHTTP headers.Adds an example snippet showing the hidden, screen-reader-only
<blockquote class="sr-only" data-agent-docs-index>markup that points agents to/llms.txt.Reviewed by Cursor Bugbot for commit 8affc4e. Bugbot is set up for automated code reviews on this repo. Configure here.