Skip to content

Conversation

@jason-kincaid
Copy link

Summary

This PR:

  • Adds guidance in the Workers LLM Prompt to direct users/LLMs to llms.txt when needed
  • Adds a new page, about-llms-txt.mdx explaining the llms.txt convention
  • Updates the LLM prompting guide to reference this resource

Please cherrypick and revise as is fitting.

To help make llms.txt discoverable
Added llms.txt to behavior_guidelines
Add llms.txt to 'Additional resources' section
@github-actions
Copy link
Contributor

Howdy and thanks for contributing to our repo. We review new, external PRs within 2 weeks. If it's been longer than then without any movement, tag the PR Assignees in a comment.

Copy link
Contributor

@hyperlint-ai hyperlint-ai bot left a comment

Choose a reason for hiding this comment

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

Hyperlint Review is complete!

Hyperlint Vale Style Guide Review

Reviewed 2 files and found 1 issues.

See the inline comments and suggestions below.

Hyperlint Link Check Review

Reviewed 2 files and found 0 issues.


We are upgrading our reviewer model! Going forward, our model will learn your particular style - which comments you all accept and reject, so that it can further personalize its suggestions.

What is Hyperlint?

Hyperlint is an AI agent that helps you write, edit, and maintain your documentation. It can review, edit, and suggest fixes for your documentation.

Learn more about the Hyperlint AI reviewer and the checks that we can run on your documentation.


## 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.

@dcpena dcpena removed their assignment Mar 11, 2025
@kodster28
Copy link
Collaborator

Closing this out as all our LLM resources are now a lot more visible within the docs (either the Copy Markdown button at the top of the page || the whole folder for /llm-resources at the bottom of the left sidenav).

@kodster28 kodster28 closed this May 28, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Projects

None yet

Development

Successfully merging this pull request may close these issues.