Skip to content
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

feat(docs): document LLMs.txt and LLMs-full.txt #5607

Merged
Merged
Show file tree
Hide file tree
Changes from 3 commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 4 additions & 0 deletions fern/docs.yml
Original file line number Diff line number Diff line change
Expand Up @@ -543,6 +543,10 @@ navigation:

- section: Developer Tools
contents:
- page: LLMs.txt
icon: fa-regular fa-laptop-code
path: ./pages/docs/developer-tools/llms-txt.mdx
slug: llms-txt
- page: Cursor
icon: fa-regular fa-laptop-code
path: ./pages/docs/developer-tools/cursor.mdx
Expand Down
2 changes: 1 addition & 1 deletion fern/fern.config.json
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
{
"organization": "fern",
"version": "*"
}
}
39 changes: 39 additions & 0 deletions fern/pages/docs/developer-tools/llms-txt.mdx
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>
Binary file added fern/pages/docs/developer-tools/llms-txt.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
2 changes: 1 addition & 1 deletion package.json
Original file line number Diff line number Diff line change
Expand Up @@ -75,7 +75,7 @@
"eslint-plugin-react-hooks": "^5.1.0",
"eslint-plugin-tailwindcss": "^3.17.5",
"execa": "^5.1.1",
"fern-api": "latest",
"fern-api": "^0.48.1",
"husky": "^9.1.7",
"immer": "^10.1.1",
"is-ci": "^4.1.0",
Expand Down
Loading