-
Notifications
You must be signed in to change notification settings - Fork 5.9k
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Add llms.txt to prompting guide, and new 'About llms.txt' page #20389
base: production
Are you sure you want to change the base?
Conversation
To help make llms.txt discoverable
Added llms.txt to behavior_guidelines
Add llms.txt to 'Additional resources' section
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. |
There was a problem hiding this 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.
@@ -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/). |
There was a problem hiding this comment.
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
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.
Summary
This PR:
Please cherrypick and revise as is fitting.