Skip to content

Commit 0076217

Browse files
talagluckgitbook-bot
authored andcommitted
GITBOOK-593: Add llms.txt page
1 parent 7e2f27a commit 0076217

File tree

2 files changed

+30
-0
lines changed

2 files changed

+30
-0
lines changed

SUMMARY.md

+4
Original file line numberDiff line numberDiff line change
@@ -90,6 +90,10 @@
9090
* [Implement Visitor Authentication using Node and Azure AD](https://docs.gitbook.com/developers/visitor-authentication/guides/implement-visitor-authentication-using-node-and-azure-ad)
9191
* [Adaptive content](publishing-documentation/adaptive-content.md)
9292

93+
***
94+
95+
* [LLM-ready docs](llm-ready-docs.md)
96+
9397
## Collaboration
9498

9599
* [Live edits](collaboration/live-edits.md)

llm-ready-docs.md

+26
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,26 @@
1+
---
2+
description: Providing an LLM-friendly version of your docs site
3+
icon: user-robot
4+
---
5+
6+
# LLM-ready docs
7+
8+
We're building features that make it easier for Large Language Models (LLMs) to ingest and work with your documentation content. 
9+
10+
As LLMs become increasingly important for information retrieval and knowledge assistance, ensuring your documentation is LLM-friendly can significantly improve how these models understand and represent your products or services.
11+
12+
## .md pages
13+
14+
With GitBook, all of the pages of your docs site are automatically available as markdown files. If you add the `.md` extension to any page, you will see the content of that page rendered in markdown which you can pass to an LLM for more efficient processing than an HTML file. 
15+
16+
For example, if your docs page is found at [https://tomatopy.pizza/docs/getting-started/basic-concepts](https://tomatopy.pizza/docs/getting-started/basic-concepts), then you can view a markdown version of the page at [https://tomatopy.pizza/docs/getting-started/basic-concepts.md](https://tomatopy.pizza/docs/getting-started/basic-concepts.md).
17+
18+
## llms.txt index page
19+
20+
[llms.txt](https://llmstxt.org/) is a proposed standard for making web content available in text-based formats that are easier for LLMs to process. You can access the `llms.txt` page by appending `/llms.txt` to the root URL of your docs site. 
21+
22+
For example, if your docs are hosted at [https://tomatopy.pizza/docs/](https://tomatopy.pizza/docs/), you will find your `llms.txt` file at [https://tomatopy.pizza/docs/llms.txt](https://tomatopy.pizza/docs/llms.txt).
23+
24+
The `llms.txt` file serves as an index for your documentation site, providing a comprehensive list of all available markdown-formatted pages. With this file, you make it easier for LLMs to efficiently discover and process your documentation content. 
25+
26+
LLMs can use this index to navigate directly to the markdown versions of your pages, allowing them to incorporate your documentation into their context without needing to parse HTML.

0 commit comments

Comments
 (0)