AI Ingestion
Learn how to feed your documentation into LLMs and AI tools
What is AI Ingestion?
AI ingestion is the process of making your documentation accessible and consumable by Large Language Models (LLMs) and other AI tools. By properly formatting and exposing your documentation, you can:
Enhanced AI Integration
Enable AI tools to better understand and process your documentation content
Improved Accessibility
Make your content more accessible to various AI-powered tools and platforms
Better User Experience
Allow users to interact with your documentation through AI-powered interfaces
Efficient Processing
Optimize how AI tools consume and analyze your documentation
Available Formats and Shortcuts
Mintlify automatically generates multiple formats of your documentation to support different AI ingestion needs. Here’s a comprehensive guide to each format:
1. llms.txt Format
The llms.txt format follows the industry standard specification for helping LLMs efficiently index content, similar to how sitemaps work for search engines.
Every documentation site automatically hosts a /llms.txt file at the root that provides a structured list of all available pages.
Open llms.txt for this siteExample structure of llms.txt:
2. llms-full.txt Format
This format is ideal when you need to provide complete documentation context to AI tools for comprehensive analysis or training.
The /llms-full.txt endpoint provides a complete markdown version of your entire documentation in a single file.
Open llms-full.txt for this siteUse cases include:
- Training custom AI models
- Building documentation-aware chatbots
- Creating comprehensive search indices
3. Markdown Version (.md)
Adding .md
to any page URL provides a markdown version of that specific page, optimized for AI processing.
Simply append .md to any documentation URL to access its markdown version:
4. Quick Access Features
Contextual Menu
Enable the contextual menu to provide users with quick actions:
- Copy markdown source
- View markdown source
- Open content directly in ChatGPT
Keyboard Shortcut
Use ⌘ + c (or Ctrl + c on Windows) to quickly copy the markdown source of any page.
Best Practices for AI Ingestion
Follow these guidelines to maximize the effectiveness of AI ingestion:
Avoid including sensitive information in your documentation as it will be accessible through these AI ingestion endpoints.
Implementation Examples
Here’s how you might use these formats in different scenarios: