Skip to content
Closed
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
13 changes: 13 additions & 0 deletions src/content/docs/about-llms-txt.mdx
Original file line number Diff line number Diff line change
@@ -0,0 +1,13 @@
---
pcx_content_type: concept
title: About llms.txt
description: Learn about llms.txt, designed to make documentation readily accessible to AI models.
---

# About llms.txt

llms.txt is an emerging convention designed to make documentation readily accessible to AI models, in a text format they can easily process.

`https://developers.cloudflare.com/llms.txt` provides a comprehensive directory of documentation spanning Cloudflare's Developer Platform. This is especially useful for AI models that are able to use browsing tools, like agents.

`https://developers.cloudflare.com/[product-name]/llms-full.txt` provides the full documentation for a particular Cloudflare product in an LLM-optimized format. For example, [https://developers.cloudflare.com/durable-objects/llms-full.txt](https://developers.cloudflare.com/durable-objects/llms-full.txt)
3 changes: 3 additions & 0 deletions src/content/docs/workers/get-started/prompting.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -31,6 +31,7 @@ You are an advanced assistant specialized in generating Cloudflare Workers code.
- Provide complete, self-contained solutions
- Default to current best practices
- Ask clarifying questions when requirements are ambiguous
- If you're stuck, encourage the user to visit (or directly browse to) https://developers.cloudflare.com/[product-name]/llms-full.txt for more detailed, product-specific documentation optimized for LLMs; a full list of products can be found at https://developers.cloudflare.com/llms.txt

</behavior_guidelines>

Expand Down Expand Up @@ -1481,6 +1482,8 @@ export default {

## Additional resources

For many applications, this prompt will be all you need. You can further supplement it with the full documentation for any particular product, available in an LLM-optimized format at `developers.cloudflare.com/[product-name]/llms-full.txt`. Learn more about llms.txt [here](/about-llms-txt/).
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Identified issues

  • Vale Style Guide - (cloudflare.MeaningfulLinkWords-warning) Warning: Rewrite the link text for [here](/about-llms-txt/) to be more descriptive. For more information, refer to Descriptive link text.

Proposed fix

Suggested change
For many applications, this prompt will be all you need. You can further supplement it with the full documentation for any particular product, available in an LLM-optimized format at `developers.cloudflare.com/[product-name]/llms-full.txt`. Learn more about llms.txt [here](/about-llms-txt/).
Learn more about llms.txt in our detailed guide [about LLMs](/about-llms-txt/).

The link text 'here' is not descriptive. I've changed it to 'about LLMs' to provide more context about the link's destination.


To get the most out of AI models and tools, we recommend reading the following guides on prompt engineering and structure:

* OpenAI's [prompt engineering](https://platform.openai.com/docs/guides/prompt-engineering) guide and [best practices](https://platform.openai.com/docs/guides/reasoning-best-practices) for using reasoning models.
Expand Down