Skip to content

docs: Improve llms.txt documentation formatting #1401

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.

Sign up for GitHub

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

Closed
wants to merge 1 commit into from
Closed

docs: Improve llms.txt documentation formatting #1401

Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
8 changes: 7 additions & 1 deletion fern/products/docs/pages/seo/llms-txt.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,11 @@
description: Enable tools like Cursor, GitHub Copilot, ChatGPT, and Claude to understand your documentation.
---

[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. When Fern detects an LLM bot accessing your documentation, it automatically serves Markdown instead of HTML, reducing token consumption by 90%+.
[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.

## Automatically serving Markdown

When Fern detects an LLM bot accessing your documentation, it automatically serves Markdown instead of HTML, reducing token consumption by 90%+.

Check warning on line 10 in fern/products/docs/pages/seo/llms-txt.mdx

View workflow job for this annotation

GitHub Actions / vale 

[vale] reported by reviewdog 🐶
[FernStyles.Acronyms] 'LLM' has no definition.

Raw Output:
{"message": "[FernStyles.Acronyms] 'LLM' has no definition.", "location": {"path": "fern/products/docs/pages/seo/llms-txt.mdx", "range": {"start": {"line": 10, "column": 22}}}, "severity": "INFO"}

<Frame>
<img
Expand All @@ -20,6 +24,7 @@
`llms.txt` is available at any level of your documentation hierarchy (`/llms.txt`, `/docs/llms.txt`, `/v1/api-reference/llms.txt`, etc.).

Examples from Eleven Labs:

- Developer documentation (Prompting directory): [elevenlabs.io/docs/best-practices/prompting/llms.txt](https://elevenlabs.io/docs/best-practices/prompting/llms.txt)
- API Reference (Create speech endpoint): [elevenlabs.io/docs/api-reference/text-to-speech/convert/llms.txt](https://elevenlabs.io/docs/api-reference/text-to-speech/convert/llms.txt)

Expand All @@ -34,6 +39,7 @@
## 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 Markdown and `llms.txt` files

Expand Down