-
Notifications
You must be signed in to change notification settings - Fork 3
Update llms.txt documentation with analytics and technical details #1384
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
Merged
Merged
Changes from 8 commits
Commits
Show all changes
12 commits
Select commit
Hold shift + click to select a range
95faf8f
Update llms.txt documentation with analytics and technical details
devin-ai-integration[bot] 58fca48
add info on llms.txt improvements
devalog 2fa561e
vale fix
devalog da4bb1b
small fix
devalog b083acb
reorganize page for clarity
devalog 8a37fcd
Clarify llms.txt availability and make example links clickable
devin-ai-integration[bot] 693f04a
remove technical details and other extra info
devalog e9ff936
nit
devalog 28047eb
Address PR feedback: move markdown serving info to llms.txt section a…
devin-ai-integration[bot] 62b717c
Update llms-full.txt example to use elevenlabs.io instead of cohere
devin-ai-integration[bot] e753c45
add better examples, update title, small restructures
devalog 2a7a1e3
fix example
devalog File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -68,3 +68,4 @@ exceptions: | |
| - MDX # Fern-specific | ||
| - SEO # Fern-specific | ||
| - AWS # Fern-specific | ||
| - LLM # Fern-specific | ||
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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,39 +1,45 @@ | ||
| --- | ||
| title: llms.txt | ||
| subtitle: Enable tools like Cursor, GitHub Copilot, ChatGPT, and Claude to quickly understand your documentation. | ||
| description: Learn how your documentation becomes accessible to AI tools using the llms.txt standard. Make your docs AI-friendly. | ||
| layout: guide | ||
| description: Enable tools like Cursor, GitHub Copilot, ChatGPT, and Claude to understand your documentation. | ||
| --- | ||
|
|
||
| ## What is llms.txt? | ||
| [LLMs.txt](https://llmstxt.org/) is an emerging standard so that websites can easily expose information to AI developer tools. | ||
| LLMs thrive on concise, structured information, and `llms.txt` help them locate and interpret key information in your developer documentation with ease. | ||
| No configuration required--your `llms.txt` files are automatically generated and maintained, just like a `sitemap.xml` or `robots.txt`. | ||
| [llms.txt](https://llmstxt.org/) is a standard for exposing website content to AI developer tools. Fern automatically generates and maintains `llms.txt` and `llms-full.txt` files for your documentation site. | ||
|
|
||
| ### llms.txt | ||
| - **Small and fast**: Quick to load and easy to parse. | ||
| - **Summary-focused**: Each page distilled into a one-sentence description with its URL. | ||
| - **Structured for AI**: Helps tools understand the overall structure of your documentation. | ||
| ## `llms.txt` | ||
|
|
||
| Contains a lightweight summary of your documentation site with each page distilled into a one-sentence description and URL. The format is structured to help AI tools parse and understand your documentation's hierarchy and organization. | ||
|
|
||
| `llms.txt` is available at any level of your documentation hierarchy (e.g., `/llms.txt`, `/docs/llms.txt`, `/v1/api-reference/llms.txt`). | ||
|
Check failure on line 12 in fern/products/docs/pages/seo/llms-txt.mdx
|
||
|
|
||
| See an example: [docs.cohere.com/llms.txt](https://docs.cohere.com/llms.txt) | ||
|
|
||
| ### llms-full.txt | ||
| - **Comprehensive**: Includes the full content of your documentation. | ||
| - **API-Ready**: Automatically incorporates your full API reference and SDK snippets (if generated by Fern). | ||
| - **Token efficient**: Removes unnecessary formatting to be as token-efficient as possible. | ||
| ## `llms-full.txt` | ||
|
|
||
| Contains complete documentation content including the full text of all pages. For API documentation, this includes your complete API Reference with resolved OpenAPI specifications and SDK code examples for enabled languages. Each API endpoint page includes its full OpenAPI spec. | ||
|
|
||
| `llms-full.txt` is available only at the root of your documentation site. | ||
|
|
||
| See an example: [docs.cohere.com/llms-full.txt](https://docs.cohere.com/llms-full.txt) | ||
| When Fern detects an LLM bot accessing your documentation, it automatically serves Markdown instead of HTML, reducing token consumption by 90%+. | ||
|
|
||
| ## View in Action | ||
| ### Examples | ||
|
|
||
| Check out the llms.txt files for this site: | ||
| - `https://buildwithfern.com/learn/llms.txt` | ||
| - `https://buildwithfern.com/learn/llms-full.txt` | ||
| View the `llms.txt` files for this site: | ||
|
|
||
| - [https://buildwithfern.com/learn/llms.txt](https://buildwithfern.com/learn/llms.txt) | ||
| - [https://buildwithfern.com/learn/llms-full.txt](https://buildwithfern.com/learn/llms-full.txt) | ||
|
|
||
| <Frame> | ||
devalog marked this conversation as resolved.
Outdated
Show resolved
Hide resolved
|
||
| <img | ||
| src="./llms-txt.png" | ||
| alt="Example of using llms.txt" | ||
| className="rounded-lg border border-gray-200 dark:border-gray-700" | ||
| /> | ||
| </Frame> | ||
| </Frame> | ||
|
|
||
| ## Analytics and monitoring | ||
|
|
||
| The [Fern Dashboard](https://dashboard.buildwithfern.com/) provides comprehensive analytics for `llms.txt` usage including: | ||
| - Traffic by LLM provider (Claude, ChatGPT, Cursor, etc.) | ||
| - Page-level breakdowns of bot vs. human visitors for `.md` and `llms.txt` files | ||
|
|
||
| This visibility helps you understand LLM traffic patterns and optimize your documentation for AI consumption. | ||
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.
Uh oh!
There was an error while loading. Please reload this page.