From 709955d956ca6d0b23b5ffdade5ef85a4bfbc945 Mon Sep 17 00:00:00 2001 From: tiffany-mintlify Date: Mon, 24 Feb 2025 17:01:04 -0800 Subject: [PATCH 1/4] added llms.txt to docs --- docs.json | 1 + settings/llms.mdx | 15 +++++++++++++++ 2 files changed, 16 insertions(+) create mode 100644 settings/llms.mdx diff --git a/docs.json b/docs.json index 381cdcce..2a7c11a6 100644 --- a/docs.json +++ b/docs.json @@ -80,6 +80,7 @@ "pages": [ "settings/custom-domain", "settings/seo", + "settings/llms", "settings/custom-scripts", "settings/broken-links", "settings/github", diff --git a/settings/llms.mdx b/settings/llms.mdx new file mode 100644 index 00000000..9157273c --- /dev/null +++ b/settings/llms.mdx @@ -0,0 +1,15 @@ +--- +title: "LLM ingestion" +icon: "diagram-project" +--- + +All documentation pages are auto-hosted in a variety of markdown formats to make it easier for: +- End users to feed your docs into large language models (LLMs) for specific information retrieval +- LLMs to efficiently index your content without parsing HTML, ads, or JavaScript + +## Supported formats +We support industry standards such as [/llms.txt](https://llmstxt.org) as well as additional markdown formats. +- **/llms.txt**: Append /llms.txt to your documentation to see a structured index. Helps general-purpose LLMs index more efficiently (e.g. a sitemap for AI). +- **/llms-full.txt**: Append /llms-full.txt to your docs URL to see a single markdown file of all your docs content. Helps users load complete context into AI tools in one link. +- **.md support**: Append .md to an individual docs page to see a markdown version of that page. Helps load individual pages into AI tools with better token efficiency & inference time. +- **⌘ + c shortcut**: Copy markdown source of any page using command + c. \ No newline at end of file From bdaa7c9bd30dbfe324bb6eceb2fc8357a82e5b31 Mon Sep 17 00:00:00 2001 From: tiffany-mintlify Date: Mon, 24 Feb 2025 17:36:45 -0800 Subject: [PATCH 2/4] Update settings/llms.mdx Co-authored-by: Han Wang <44352119+handotdev@users.noreply.github.com> --- settings/llms.mdx | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/settings/llms.mdx b/settings/llms.mdx index 9157273c..9038aaa9 100644 --- a/settings/llms.mdx +++ b/settings/llms.mdx @@ -1,5 +1,5 @@ --- -title: "LLM ingestion" +title: "LLM Ingestion" icon: "diagram-project" --- From 4969b3c6813020e8c97a0c966b20c6427b721da6 Mon Sep 17 00:00:00 2001 From: tiffany-mintlify Date: Mon, 24 Feb 2025 17:53:09 -0800 Subject: [PATCH 3/4] added description --- settings/llms.mdx | 9 +++++---- 1 file changed, 5 insertions(+), 4 deletions(-) diff --git a/settings/llms.mdx b/settings/llms.mdx index 9038aaa9..e8236810 100644 --- a/settings/llms.mdx +++ b/settings/llms.mdx @@ -1,5 +1,6 @@ --- -title: "LLM Ingestion" +title: "LLM ingestion" +description: "How to feed your docs into LLMs" icon: "diagram-project" --- @@ -9,7 +10,7 @@ All documentation pages are auto-hosted in a variety of markdown formats to make ## Supported formats We support industry standards such as [/llms.txt](https://llmstxt.org) as well as additional markdown formats. -- **/llms.txt**: Append /llms.txt to your documentation to see a structured index. Helps general-purpose LLMs index more efficiently (e.g. a sitemap for AI). -- **/llms-full.txt**: Append /llms-full.txt to your docs URL to see a single markdown file of all your docs content. Helps users load complete context into AI tools in one link. -- **.md support**: Append .md to an individual docs page to see a markdown version of that page. Helps load individual pages into AI tools with better token efficiency & inference time. +- **/llms.txt**: A markdown file of a structured index of your docs is automatically hosted at /llms.txt. Helps general-purpose LLMs index more efficiently (e.g. a sitemap for AI). +- **/llms-full.txt**: A markdown file of all your docs content is automatically hosted at /llms-full.txt. Helps users load complete context into AI tools in one link. +- **.md support**: Add .md to an individual docs page to see a markdown version of that page. Helps load individual pages into AI tools with better token efficiency & inference time. - **⌘ + c shortcut**: Copy markdown source of any page using command + c. \ No newline at end of file From c29a02c04b7c9bc014e3bbff9bc22d8146f35946 Mon Sep 17 00:00:00 2001 From: tiffany-mintlify Date: Mon, 24 Feb 2025 17:54:42 -0800 Subject: [PATCH 4/4] added capitalization --- settings/llms.mdx | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/settings/llms.mdx b/settings/llms.mdx index e8236810..916c19a9 100644 --- a/settings/llms.mdx +++ b/settings/llms.mdx @@ -1,5 +1,5 @@ --- -title: "LLM ingestion" +title: "LLM Ingestion" description: "How to feed your docs into LLMs" icon: "diagram-project" ---