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

added llms.txt to docs #544

Open
wants to merge 4 commits into
base: main
Choose a base branch
from
Open
Show file tree
Hide file tree
Changes from all 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
1 change: 1 addition & 0 deletions docs.json
Original file line number Diff line number Diff line change
Expand Up @@ -80,6 +80,7 @@
"pages": [
"settings/custom-domain",
"settings/seo",
"settings/llms",
"settings/custom-scripts",
"settings/broken-links",
"settings/github",
Expand Down
16 changes: 16 additions & 0 deletions settings/llms.mdx
Original file line number Diff line number Diff line change
@@ -0,0 +1,16 @@
---
title: "LLM Ingestion"
description: "How to feed your docs into LLMs"
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

Check warning on line 8 in settings/llms.mdx

View check run for this annotation

Mintlify / Mintlify Validation - vale-spellcheck

settings/llms.mdx#L8

Did you really mean 'LLMs'?
- LLMs to efficiently index your content without parsing HTML, ads, or JavaScript

Check warning on line 9 in settings/llms.mdx

View check run for this annotation

Mintlify / Mintlify Validation - vale-spellcheck

settings/llms.mdx#L9

Did you really mean 'LLMs'?

## Supported formats
We support industry standards such as [/llms.txt](https://llmstxt.org) as well as additional markdown formats.
- **/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).

Check warning on line 13 in settings/llms.mdx

View check run for this annotation

Mintlify / Mintlify Validation - vale-spellcheck

settings/llms.mdx#L13

Did you really mean 'LLMs'?
- **/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.