Skip to content

Commit 23824e4

Browse files
committed
reviewer feedback
1 parent 0d5171d commit 23824e4

File tree

2 files changed

+10
-13
lines changed

2 files changed

+10
-13
lines changed

ai/llmstxt.mdx

Lines changed: 9 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -1,16 +1,16 @@
11
---
22
title: "llms.txt"
3-
description: "Make your content easier for LLMs to understand"
3+
description: "Make your content easier for LLMs to read and index"
44
icon: "file-code"
55
---
66

77
import { PreviewButton } from "/snippets/previewbutton.jsx"
88

99
The [llms.txt file](https://llmstxt.org) is an industry standard that helps LLMs index content more efficiently, similar to how a sitemap helps search engines.
1010

11-
Every documentation site automatically hosts an `llms.txt` file at the root that lists all available pages in your documentation. AI tools can use this file to understand your documentation structure and find relevant content to user prompts.
11+
Mintlify automatically hosts an `llms.txt` file at the root of your project that lists all available pages in your documentation. AI tools can use this file to understand your documentation structure and find relevant content to user prompts.
1212

13-
View your `llms.txt` by appending `/llms.txt` to your site's URL.
13+
View your `llms.txt` by appending `/llms.txt` to your documentation site's URL.
1414

1515
<PreviewButton href="https://mintlify.com/docs/llms.txt">Open the llms.txt for this site</PreviewButton>
1616

@@ -21,29 +21,26 @@ Your site's `llms.txt` is always up to date and requires zero maintenance.
2121
An `llms.txt` file is a plain Markdown file that contains:
2222

2323
- **Site title** as an H1 heading. This is the only required section of an `llms.txt`.
24-
- **Site summary** typically in a blockquote.
2524
- **Structured content sections** with descriptive links to key pages.
2625

2726
```mdx Example llms.txt
2827
# Example product docs
2928

30-
> Learn how to get started, use the API, and explore tutorials.
29+
## Guides
30+
- [Getting started](https://example.com/docs/start): Intro guide
31+
- [Install](https://example.com/docs/install): Setup steps
3132

32-
## Guides
33-
- [Getting started](https://example.com/docs/start): Intro guide
34-
- [Install](https://example.com/docs/install): Setup steps
35-
36-
## Reference
33+
## Reference
3734
- [API](https://example.com/docs/api): Endpoint list and usage
3835
```
3936

4037
This structured approach allows LLMs to quickly process your documentation hierarchy and locate relevant content for user queries, improving the accuracy and speed of AI-assisted documentation searches.
4138

4239
## llms-full.txt
4340

44-
The `llms-full.txt` file combines your entire documentation site into a single file as context for AI tools. Users can paste a single URL as context for AI tools for more relevant and accurate responses.
41+
The `llms-full.txt` file combines your entire documentation site into a single file as context for AI tools and is indexed by LLM traffic. Users can paste a single URL as context for AI tools for more relevant and accurate responses.
4542

46-
Every documentation site automatically hosts an `llms-full.txt` file at the root. View your `llms-full.txt` by appending `/llms-full.txt` to your site's URL.
43+
Mintlify automatically hosts an `llms-full.txt` file at the root of your project. View your `llms-full.txt` by appending `/llms-full.txt` to your documentation site's URL.
4744

4845
<PreviewButton href="https://mintlify.com/docs/llms-full.txt">Open the llms-full.txt for this site</PreviewButton>
4946

ai/markdown-export.mdx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -18,4 +18,4 @@ Add `.md` to any page's URL to view a Markdown version.
1818

1919
## Keyboard shortcut
2020

21-
Press <kbd>Command</kbd> + <kbd>C</kbd> (<kbd>Ctrl</kbd> + <kbd>C</kbd> on Windows) to copy a page as Markdown to yourclipboard.
21+
Press <kbd>Command</kbd> + <kbd>C</kbd> (<kbd>Ctrl</kbd> + <kbd>C</kbd> on Windows) to copy a page as Markdown to your clipboard.

0 commit comments

Comments
 (0)