Skip to content

Commit 9081206

Browse files
authored
Add llms.txt documentation support (#828)
1 parent fbf5555 commit 9081206

File tree

1 file changed

+61
-0
lines changed

1 file changed

+61
-0
lines changed

blog/2025-10-17-llms-txt.mdx

Lines changed: 61 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,61 @@
1+
---
2+
title: Making Our Docs AI-Friendly with llms.txt
3+
slug: llms-txt
4+
authors: [osterman]
5+
tags: [documentation, ai, llm]
6+
date: 2025-10-17
7+
---
8+
9+
import Intro from '@site/src/components/Intro';
10+
11+
<Intro>
12+
We've implemented the llms.txt standard to make our documentation more accessible to AI assistants, ensuring better responses when you ask ChatGPT, Claude, or other LLMs about Cloud Posse tools and best practices.
13+
</Intro>
14+
15+
Hello SweetOps!
16+
17+
As AI assistants become increasingly integrated into developer workflows, we're excited to announce support for the [llms.txt standard](https://llmstxt.org/) across our documentation site.
18+
19+
## What is llms.txt?
20+
21+
Think of `llms.txt` as the AI equivalent of `robots.txt` for search engines. It's an emerging standard that provides LLMs with structured, curated documentation in a format optimized for their understanding. Rather than crawling entire websites and hitting context window limits, AI assistants can now access our documentation in two curated formats:
22+
23+
- **[/llms.txt](https://docs.cloudposse.com/llms.txt)** - A compact list of important documentation links
24+
- **[/llms-full.txt](https://docs.cloudposse.com/llms-full.txt)** - Full documentation content in markdown format
25+
26+
## Why This Matters
27+
28+
When you ask an AI assistant about Atmos, Terraform components, or Cloud Posse best practices, you'll get more accurate and up-to-date responses. The assistant can reference our curated documentation directly instead of relying on training data that may be outdated or incomplete.
29+
30+
### Benefits for the Community
31+
32+
- **Better AI Assistance**: More accurate responses when asking AI tools about our projects
33+
- **Efficient Context Usage**: LLMs can access precisely what they need without crawling
34+
- **Up-to-Date Information**: Always references current documentation, not stale training data
35+
- **Developer Velocity**: Faster answers means less time searching, more time building
36+
37+
## How It Works
38+
39+
We're using the [`docusaurus-plugin-llms`](https://github.com/rachfop/docusaurus-plugin-llms) to automatically generate these files from our Docusaurus site. The plugin:
40+
41+
1. Prioritizes core documentation sections (Atmos, components, tutorials)
42+
2. Includes blog content for recent updates and announcements
43+
3. Generates both compact and full-text versions
44+
4. Automatically updates with each documentation deployment
45+
46+
## Try It Out
47+
48+
Next time you're working with an AI assistant, try asking questions about:
49+
- "How do I configure Atmos stacks?"
50+
- "What's the latest on Cloud Posse component deprecation?"
51+
- "Show me examples of Terraform component patterns"
52+
53+
The assistant will have direct access to our structured documentation, leading to better, more accurate responses.
54+
55+
## Join the Movement
56+
57+
The llms.txt standard is gaining adoption across the developer community. If you maintain documentation, consider implementing it for your projects. It's a simple way to make your content more accessible to the AI tools your users are already using.
58+
59+
:::tip Questions?
60+
Have feedback about our AI-friendly documentation? Join us in the [SweetOps Slack](https://cloudposse.com/slack) or [GitHub Discussions](https://github.com/orgs/cloudposse/discussions).
61+
:::

0 commit comments

Comments
 (0)