-
Notifications
You must be signed in to change notification settings - Fork 164
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
feat(docs): document LLMs.txt and LLMs-full.txt (#5607)
* Revert "Revert "feat(docs): document LLMs.txt and LLMs-full.txt" (#5606)" This reverts commit c654ccf. * Update titleCase.ts * Delete fern/pages/docs/components/icons.mdx * Update icon for Cursor page in docs --------- Co-authored-by: Danny Sheridan <[email protected]>
- Loading branch information
1 parent
c654ccf
commit f70b601
Showing
5 changed files
with
46 additions
and
3 deletions.
There are no files selected for viewing
This file contains 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
This file contains 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,4 +1,4 @@ | ||
{ | ||
"organization": "fern", | ||
"version": "*" | ||
} | ||
} |
This file contains 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 |
---|---|---|
@@ -0,0 +1,39 @@ | ||
--- | ||
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 | ||
--- | ||
|
||
## 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 | ||
- **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. | ||
|
||
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 unncessary formatting to be as token-efficient as possible. | ||
|
||
See an example: [docs.cohere.com/llms-full.txt](https://docs.cohere.com/llms-full.txt) | ||
|
||
## View in Action | ||
|
||
Check out the llms.txt files for this site: | ||
- `https://buildwithfern.com/learn/llms.txt` | ||
- `https://buildwithfern.com/learn/llms-full.txt` | ||
|
||
<Frame> | ||
<img | ||
src="./llms-txt.png" | ||
alt="Example of using llms.txt" | ||
className="rounded-lg border border-gray-200 dark:border-gray-700" | ||
/> | ||
</Frame> |
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
This file contains 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