Skip to content

Commit

Permalink
feat(docs): document LLMs.txt and LLMs-full.txt (#5607)
Browse files Browse the repository at this point in the history
* 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
dsinghvi and dannysheridan authored Jan 14, 2025
1 parent c654ccf commit f70b601
Show file tree
Hide file tree
Showing 5 changed files with 46 additions and 3 deletions.
6 changes: 5 additions & 1 deletion fern/docs.yml
Original file line number Diff line number Diff line change
Expand Up @@ -543,8 +543,12 @@ navigation:

- section: Developer Tools
contents:
- page: Cursor
- 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-mouse-pointer
path: ./pages/docs/developer-tools/cursor.mdx
- page: GitLab
slug: gitlab
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

0 comments on commit f70b601

Please sign in to comment.