Skip to content

Commit 8bf6505

Browse files
Merge pull request #2350 from redis/DOC-5877-for-ais-only
DOC-5877 added 'hidden' AI resource page plus tile on docs home page
2 parents e93ebd2 + 56d0d98 commit 8bf6505

File tree

2 files changed

+43
-1
lines changed

2 files changed

+43
-1
lines changed

content/ai-agent-resources.md

Lines changed: 27 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,27 @@
1+
---
2+
title: AI Agent Resources
3+
description: Learn how to develop with Redis as an AI agent
4+
linkTitle: AI Agent Resources
5+
---
6+
7+
## `llms.txt` index of documentation
8+
9+
Redis provides a comprehensive index of all documentation in Markdown format at [llms.txt](https://redis.io/llms.txt). This index is specifically designed for AI agents to discover available documentation.
10+
11+
## Markdown documentation format
12+
13+
All documentation pages are available in Markdown format via the same URL as
14+
the main doc page but with `index.html.md` added. For example, the Markdown version of
15+
this page is available at
16+
[ai-agent-resources/index.html.md](https://redis.io/docs/latest/ai-agent-resources/index.html.md).
17+
18+
19+
## API references
20+
21+
API references are available for the following client libraries:
22+
23+
- [redis-py](https://redis.readthedocs.io/en/stable/commands.html)
24+
- [jedis](https://javadoc.io/doc/redis.clients/jedis/latest/index.html)
25+
- [lettuce](https://lettuce.io/core/release/reference/index.html)
26+
- [go-redis](https://pkg.go.dev/github.com/redis/go-redis/v9)
27+
- [redis-rs](https://docs.rs/redis/latest/redis/)

layouts/home.html

Lines changed: 16 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,12 @@
11
{{ define "head" }}
22

33
<script src='{{ relURL "js/cli.js" }}' defer></script>
4+
5+
<!-- AI-friendliness meta tags -->
6+
<meta name="ai-documentation" content="https://redis.io/llms.txt">
7+
<meta name="ai-formats" content="markdown">
8+
<link rel="ai-documentation" href="https://redis.io/llms.txt" type="text/plain">
9+
410
{{ end }}
511

612
{{ define "main" }}
@@ -115,6 +121,16 @@ <h2 class="text-5xl font-medium text-white" id="operate">Get Started</h2>
115121
(dict "Text" "Go" "URL" "./develop/clients/go/")
116122
(dict "Text" "PHP" "URL" "./develop/clients/php/")
117123
) ) }}
124+
{{ partial "docs-section.html" (dict
125+
"Title" "Resources for AI agents"
126+
"Description" "Learn more about Redis documentation features that support AI agents"
127+
"ButtonLink" "https://redis.io/llms.txt"
128+
"ButtonLabel" "Main `llms.txt` index for doc structure"
129+
"LinksLeft" (slice
130+
(dict "Text" "AI Agent Resources" "URL" "./ai-agent-resources")
131+
(dict "Text" "Example doc page in Markdown format" "URL" "./develop/index.html.md")
132+
)
133+
) }}
118134
</div>
119135
<div class="lg:px-11 w-full flex flex-col gap-3">
120136
<h2 class="text-5xl font-medium text-white" id="operate">Deploy</h2>
@@ -164,7 +180,6 @@ <h2 class="text-5xl font-medium text-white" id="operate">Deploy</h2>
164180
(dict "Text" "Redis Insight" "URL" "./develop/tools/insight/")
165181
(dict "Text" "Redis for VSCode" "URL" "./develop/tools/redis-for-vscode/")
166182
) ) }}
167-
168183
</div>
169184
</div>
170185
</div>

0 commit comments

Comments
 (0)